AbstractEvent

Entity for state change and much more.

You cannot create an instance of it, but Event, DebouncedEvent and ThrottledEvent inherits its behavior

Has the same api as AbstractEntity

dispatch (method)

Notifies listeners with payload

Interface:

function dispatch(payload: T): void;

Example:

const $m = new SvitoreModule();

const changeCount = $m.Event<number>();
changeCount.subscribe(console.log);

changeCount.dispatch(10); // log: 10

applyMiddleware (method)

Add middleware

Interface:

type MiddlewareContext<T> = {
  value: T;
};

type Middleware<T> = (context: MiddlewareContext<T>, next: () => void) => void;

function applyMiddleware<E extends Error>(
  middleware: Middleware<T>,
  errorEvent?: AbstractEvent<E>
): AbstractEvent<T>;

Example:

Common:

const $m = new SvitoreModule();

const changeCount = $m.Event<number>();

const logMiddleware: Middleware<number> = (context, next) => {
  console.log(context.value);
  next();
};

changeCount.applyMiddleware(logMiddleware);

changeCount.dispatch(10); // log: 10

Validation:

const $m = new SvitoreModule();

const changeCount = $m.Event<number>();
const errorEvent = $m.Event<Error>();

errorEvent.subscribe((error) => console.log(error.message));

const validationMiddleware: Middleware<number> = (context, next) => {
  if (context.value < 11) throw new Error("to small");

  next();
};

changeCount.applyMiddleware(validationMiddleware, errorEvent);

changeCount.dispatch(10); // log: "to small"

on (method)

Set a trigger to trigger the event

Interface:

function on<EntityPayload extends T>(entity: Entity<EntityPayload>): this;

function on<EntityPayload>(
  entity: Entity<EntityPayload>,
  selector: (payload: EntityPayload) => T
): this;

Example:

Common:

const $m = new SvitoreModule();

const changeCount = $m.Event<number>();
const trigger = $m.Event<number>();

changeCount.subscribe(console.log);
changeCount.on(trigger);

trigger.dispatch(10); // log: 10

Advanced:

const $m = new SvitoreModule();

const changeCount = $m.Event<number>();
const trigger = $m.Event<string>();

changeCount.subscribe(console.log);
changeCount.on(trigger, (payload) => Number(payload));

trigger.dispatch("10"); // log: 10