Interface UseModel

Callable

• UseModel<TProps>(creator: (create: Create) => TProps, options?: UseModelOptions<TProps>): Model<TProps>
• UseModel<TProps>(creator: (create: Create) => TProps, update?: (prev: TProps) => Partial<TProps>): Model<TProps>
• UseModel<T, TProps>(listenable: T, options?: Omit<UseModelOptions<TProps>, "update">): T
• UseModel(listenable: Listenable[], options?: Omit<UseModelOptions<any>, "update">): void
• UseModel<T, TResult>(listenable: T, selector: T extends Listenable ? (props: T) => TResult : T extends Record<string, any> ? (allProps: { [ key in string | number | symbol]: T[key] }) => TResult : never, compareFn?: Comparer<any>): TResult
• UseModel<TProps>(props: TProps): Model<TProps>
• UseModel<TProps>(props: TProps, update: (prev: TProps) => Partial<TProps>): Model<TProps>

• Type parameters

  • TProps: {}

  Parameters

  • creator: (create: Create) => TProps

    • • (create: Create): TProps

      • Parameters

        • create: Create

        Returns TProps

  • Optional options: UseModelOptions<TProps>

  Returns Model<TProps>

• Type parameters

  • TProps: {}

  Parameters

  • creator: (create: Create) => TProps

    • • (create: Create): TProps

      • Parameters

        • create: Create

        Returns TProps

  • Optional update: (prev: TProps) => Partial<TProps>

    • • (prev: TProps): Partial<TProps>

      • Parameters

        • prev: TProps

        Returns Partial<TProps>

  Returns Model<TProps>

• Type parameters

  • T: Listenable

  • TProps

  Parameters

  • listenable: T

  • Optional options: Omit<UseModelOptions<TProps>, "update">

  Returns T

• Parameters

  • listenable: Listenable[]

  • Optional options: Omit<UseModelOptions<any>, "update">

  Returns void

• Type parameters

  • T

  • TResult

  Parameters

  • listenable: T

  • selector: T extends Listenable ? (props: T) => TResult : T extends Record<string, any> ? (allProps: { [ key in string | number | symbol]: T[key] }) => TResult : never

  • Optional compareFn: Comparer<any>

  Returns TResult

• Type parameters

  • TProps: {}

  Parameters

  • props: TProps

  Returns Model<TProps>

• Type parameters

  • TProps: {}

  Parameters

  • props: TProps

  • update: (prev: TProps) => Partial<TProps>

    • • (prev: TProps): Partial<TProps>

      • Parameters

        • prev: TProps

        Returns Partial<TProps>

  Returns Model<TProps>