Skip to content

@stephansama packages / @stephansama/typed-events / index / Validator

Interface: Validator<Name, Schema, EventTypeKeys, DispatchOpts, Input>

Defined in: utils/types.ts:25

Extended by

Type Parameters

Name

Name extends string

Schema

Schema extends StandardSchemaV1

EventTypeKeys

EventTypeKeys extends keyof RawEventMap

DispatchOpts

DispatchOpts = { }

Input

Input = object & StandardSchemaV1.InferInput<Schema>

Properties

name

ts
name: Name;

Defined in: utils/types.ts:35


schema

ts
schema: Schema;

Defined in: utils/types.ts:36

Methods

dispatch()

ts
dispatch(input, opts?): void;

Defined in: utils/types.ts:32

Parameters

input

Input

opts?

DispatchOpts

Returns

void


listen()

ts
listen(callback): () => void;

Defined in: utils/types.ts:33

Parameters

callback

ListenerCallback<Input, EventTypeKeys>

Returns

ts
(): void;
Returns

void

Released under MIT license