Shouldn't type DeepSignalObject be exported?

[Jim Cook]

I'm attempting to create a store using deepsignal in TypeScript.

I'm having a problem when I attempt to type my store, and in particular my Store's state object. Don't I need to declare state as a type of DeepSignalObject? But that type is not exported from the library.

interface AuthState {
  auth: boolean;
}

interface AuthActions {
  isAuthenticated: () => boolean;
  setIsAuthenticated: (isAuthenticated: boolean) => void;
  signOut: () => void;
}

interface DeepAuthState {
  state: DeepSignalObject<AuthState>;
}

type AuthStore = DeepAuthState & AuthActions;

export const authStore: AuthStore = {
  state: deepSignal<AuthState>({
    auth: false,
  }),

  isAuthenticated() {
    return this.state.auth;
  },

  setIsAuthenticated(isAuthenticated: boolean): void {
    this.state.auth.value = isAuthenticated;
  },

  signOut(): void {
    setIsAuthenticated(false);
  },
};

[Luis Herranz]

Just use the DeepSignal type:

import { deepSignal, DeepSignal } from "deepsignal";

interface AuthState {
  auth: boolean;
}

interface AuthActions {
  isAuthenticated: () => boolean;
  setIsAuthenticated: (isAuthenticated: boolean) => void;
  signOut: () => void;
}

interface DeepAuthState {
  state: DeepSignal<AuthState>; // Use the DeepSignal type
}

type AuthStore = DeepAuthState & AuthActions;

export const authStore: AuthStore = {
  state: deepSignal<AuthState>({
    auth: false,
  }),

  isAuthenticated() {
    return this.state.auth;
  },

  setIsAuthenticated(isAuthenticated: boolean): void {
    this.state.auth = isAuthenticated; // Don't use .value here, just mutate the object prop
  },

  signOut(): void {
    this.setIsAuthenticated(false);
  },
};

[Jim Cook]

Thanks for that!

[Luis Herranz]

No problem 🙂

[Luis Herranz]

I've improved the docs to explain how DeepSignal works: bf1bae2