Interface JustEventDuo<Type, Value, Meta>

Event with Value and Meta

interface JustEventDuo<Type extends string, Value, Meta extends JustMeta> {
    type: Type;
    emitBy(
        emitter: EventEmitterLike | EventTargetLike,
        value: Value,
        meta: Meta,
    ): void;
    listener(
        listener: (value: Value, meta: Meta) => unknown,
    ): (...args: any[]) => any;
    listenTo(
        emitter: EventEmitterLike | EventTargetLike,
        listener: (value: Value, meta: Meta) => unknown,
    ): void;
    (value: Value, meta: Meta): JustDuo<Value, Meta>;
}

Type Parameters

Type extends string
Value
Meta extends JustMeta

JustEventDuo(value: Value, meta: Meta): JustDuo<Value, Meta>
Create event argments as in emitter.emit(event.type, ...event(value, meta)).
Parameters
- value: Value
- meta: Meta
Returns JustDuo<Value, Meta>
- Defined in justEvent.ts:15

Index

Properties

Methods

emitBy listener listenTo

Properties

type

type: Type

The event type: emitter.emit(event.type)

Methods

emitBy

emitBy(
    emitter: EventEmitterLike | EventTargetLike,
    value: Value,
    meta: Meta,
): void
A functional and normalized way to call emitter.emit(...)
Parameters
- emitter: EventEmitterLike | EventTargetLike
- value: Value
- meta: Meta
Returns void
- Defined in justEvent.ts:27

listener

listener(
listener: (value: Value, meta: Meta) => unknown,
): (...args: any[]) => any
creates the event listener with type support
Parameters
- listener: (value: Value, meta: Meta) => unknown
Returns (...args: any[]) => any
- Defined in justEvent.ts:19

listenTo

listenTo(
emitter: EventEmitterLike | EventTargetLike,
listener: (value: Value, meta: Meta) => unknown,
): void
A functional and normalized way to call emitter.addListener(...)
Parameters
- emitter: EventEmitterLike | EventTargetLike
- listener: (value: Value, meta: Meta) => unknown
Returns void
- Defined in justEvent.ts:23