Class StreamModel<State>

constructor

• new StreamModel<State>(initialState): StreamModel<State>

• Create a new StreamModel by providing the initial state.

  Type Parameters

  • State

  Parameters

  • initialState: State

    The initial state of the stream.

  Returns StreamModel<State>

Readonly initialState

spawn

• spawn(props): Stream<State>

• Spawns a new stream from this model. This stream can be used to dispatch events and subscribe to changes in the state.

  Parameters

  • props: StreamProps

    The configuration for the stream.

  Returns Stream<State>

when

• when<Type, PayloadSchema>(type, payloadSchema, handler): PayloadSchema extends ZodUndefined
      ? (() => {
          payload: undefined;
          type: Type;
      })
      : ((payload) => {
          payload: TypeOf<PayloadSchema>;
          type: Type;
      })

• Adds a new handler for when a specific type of event is dispatched.

  Type Parameters

  • Type extends string
  • PayloadSchema extends ZodType<any, any, any>

  Parameters

  • type: Type

    The identifier of the event. This must be unique for this event source. For example: 'increment'
  • payloadSchema: PayloadSchema

    The Zod schema to use for the payload of the event. For example z.number().int().min(1).max(5)
  • handler: ((state, dispatcher, payload) => void | State)

    The handler that will apply the payload to the state. This method receives the state, the dispatcher, and the payload. You can manipulate the state directly (made possible by Immer) or return a new state object.

    • • (state, dispatcher, payload): void | State

      • Parameters

        • state: State
        • dispatcher: string
        • payload: TypeOf<PayloadSchema>

        Returns void | State

  Returns PayloadSchema extends ZodUndefined
      ? (() => {
          payload: undefined;
          type: Type;
      })
      : ((payload) => {
          payload: TypeOf<PayloadSchema>;
          type: Type;
      })

  Returns a constructor for creating type safe events.