Class Effect<Input, Output>

Immutable descriptor for a typed effect.

Effect instances are created by createEffect. They hold the public name, input/output schemas, rate-limit/cache options, and handler function, but no runtime state. All mutable data such as memoized results, queued calls, in-flight promises, and rate-limit windows lives in EffectRunner.

Template: Input

Template: Output

Type Parameters

Input
Output

Index

Constructors

constructor

Properties

cache handler input name output rateLimit

Constructors

constructor

new Effect<Input, Output>(
    options: EffectOptions<
        StandardSchemaV1<Input, Input>,
        StandardSchemaV1<Output, Output>,
    >,
    handler: EffectHandler<Input, Output>,
): Effect<Input, Output>
Creates an immutable effect descriptor.

Prefer createEffect for public construction because it validates the descriptor and preserves Standard Schema type inference.
Type Parameters
- Input
- Output
Parameters
- options: EffectOptions<StandardSchemaV1<Input, Input>, StandardSchemaV1<Output, Output>>
- handler: EffectHandler<Input, Output>
Returns Effect<Input, Output>
- Defined in index.js:143

Properties

cache

cache: boolean

handler

handler: EffectHandler<Input, Output>

input

input: StandardSchemaV1<Input, Input>

name

name: string

output

output: StandardSchemaV1<Output, Output>

rateLimit

rateLimit: RateLimit

Class Effect<Input, Output>

Template: Input

Template: Output

Type Parameters

Index

Constructors

Properties

Constructors

constructor

Type Parameters

Parameters

Returns Effect<Input, Output>

Properties

cache

handler

input

name

output

rateLimit

Settings

On This Page