Skip to main content
Foldkit
On this pageFunctions

Subscription

Functions

makeSubscriptions

functionsource

Creates type-safe subscription configurations from a dependency schema.

Types

Subscription

typesource

A reactive binding between model state and a long-running stream of commands.

type Subscription = {
  depsToStream: (deps: StreamDeps) => Stream.Stream<Command<Message, never, Resources>, never, Resources>
  modelToDependencies: (model: Model) => StreamDeps
}

Subscriptions

typesource

A record of named subscription configurations, keyed by dependency field name.

type Subscriptions = {
  readonly [K in keyof Schema.Schema.Type<SubscriptionDeps>]: SubscriptionConfig<Model, Message, Schema.Schema.Type<SubscriptionDeps>[K], Resources>
}