Interface Event<Payload>

A CloudpilotEmu event.

interface Event<Payload> {
    addHandler<Context>(
        handler: Handler<Payload, Context>,
        context?: Context,
    ): Event<Payload>;
    removeHandler<Context>(
        handler: Handler<Payload, Context>,
        context?: Context,
    ): Event<Payload>;
}

Type Parameters

Payload

Index

Methods

addHandler removeHandler

Methods

addHandler

addHandler<Context>(
handler: Handler<Payload, Context>,
context?: Context,
): Event<Payload>
Bind an handler callback to the event.

CAUTION: a handler that is bound multiple times will be called multiple times, too!
Type Parameters
- Context
Parameters
- handler: Handler<Payload, Context>
  Handler callback.
- Optionalcontext: Context
  Optional context that is passed to the callback.
Returns Event<Payload>
- Defined in embedded/src/Event.ts:13

removeHandler

removeHandler<Context>(
handler: Handler<Payload, Context>,
context?: Context,
): Event<Payload>
Remove a previously bound handler. Both callback and context must be identical for the handler to be removed.

CAUTION: this method will only remove one callback each call, even if a handler / callback combo is bound multiple times.
Type Parameters
- Context
Parameters
- handler: Handler<Payload, Context>
  Handler callback.
- Optionalcontext: Context
  Optional callback context.
Returns Event<Payload>
- Defined in embedded/src/Event.ts:25