Event Bus

Bindings for @solid-primitives/event-bus.

createEventBus

let createEventBus<'T>(): EventBus<'T>

let createEmitter<'T>(): Emitter<'T>

let createMappedEmitter<'MessageSchema>(): MappedEmitter<'MessageSchema>

See MappedEmitter, a binding made for F#.

let createEventHub<'T> (?channels: 'T): EventHub<'T>

type EventBus<'T> = interface

A single-event emitter with listener management.

member listen: ('T -> unit) -> DisposeCallback

The listener is removed automatically on cleanup. Call the returned callback to remove it earlier.

member emit: 'T -> unit

member clear: unit -> unit

type Emitter<'MessageTyper> = interface

An emitter for multiple named events.

member on: (string * (obj -> unit)) -> DisposeCallback

The subscription is removed automatically on cleanup. Call the returned callback to remove it earlier.

member emit: (string * obj) -> unit

member clear: unit -> unit

type MappedEmitter<'MessageMapper> = interface

A type-safe Emitter, made for F#. The event key is the path to a member of 'MessageMapper, so the message has that member's type.

member on
    (mapping: 'MessageMapper -> 'MessageType)
    (callback: 'MessageType -> unit)
    : DisposeCallback

member emit
    (mapping: 'MessageMapper -> 'MessageType)
    (message: 'MessageType)
    : unit

member clear: unit -> unit

type GlobalEmitter<'T> = inherit Emitter<'T>

An emitter that can also listen to every event.

member listen: (obj -> unit) -> DisposeCallback

type EventHub<'T> = inherit GlobalEmitter<'T>

Helpers for using a group of event buses. Works with createEventBus, createEventStack, or any emitter with the same API.