Function run

run<
    State,
    Model,
    Message,
    Command = never,
    R = never,
    RR = never,
    Flags = never,
>(
    program: Shape<State, Model, Message, Command, R, never, unknown, Flags>,
    render: (
        frames: Stream<Readonly<{ dispatch: Dispatch<Message>; model: Model }>>,
    ) => Effect<void, never, RR>,
    ...__namedParameters: [Flags] extends [never]
        ? [
            options?: RunOptions<
                NoInfer<Message>,
                NoInfer<State>,
                NoInfer<Command>,
            >,
        ]
        : [
            options: RunOptions<
                NoInfer<Message>,
                NoInfer<State>,
                NoInfer<Command>,
            > & FlagsOption<NoInfer<Flags>>,
        ],
): Effect<void, never, Exclude<R, Scope> | Exclude<RR, Scope>>
Runs program from its flags, when it has them, and hands its frames to render. A message update rejects is ignored: the state it was meant for is gone, or it never applied.
Type Parameters
- State
- Model
- Message
- Command = never
- R = never
- RR = never
- Flags = never
Parameters
- program: Shape<State, Model, Message, Command, R, never, unknown, Flags>
- render: (
  frames: Stream<Readonly<{ dispatch: Dispatch<Message>; model: Model }>>,
  ) => Effect<void, never, RR>
- ...__namedParameters: [Flags] extends [never]
      ? [
          options?: RunOptions<
              NoInfer<Message>,
              NoInfer<State>,
              NoInfer<Command>,
          >,
      ]
      : [
          options: RunOptions<NoInfer<Message>, NoInfer<State>, NoInfer<Command>> & FlagsOption<
              NoInfer<Flags>,
          >,
      ]
Returns Effect<void, never, Exclude<R, Scope> | Exclude<RR, Scope>>
- Defined in src/run.ts:55

Function run

Type Parameters

Parameters

Returns Effect<void, never, Exclude<R, Scope> | Exclude<RR, Scope>>

Settings