nyx Typedoc
    Preparing search index...

    Interface EventBus<ArgsRecord>

    An object that holds methods for subscribing to and emitting events, and getting information about the subscribers and subscribed events.

    interface EventBus<
        ArgsRecord extends Record<keyof ArgsRecord & string, unknown[]>,
    > {
        "[iterator]"(): IterableIterator<
            [Identifier, AnyEventSubscriberFrom<ArgsRecord>],
            any,
            any,
        >;
        clearSubscribers(
            eventName?: string,
            clearProtected?: boolean,
        ): Awaitable<EventBus<ArgsRecord>>;
        emit<const EventName extends string>(
            eventName: EventName,
            args: ArgsRecord[EventName],
            meta?: Metadata,
        ): Awaitable<EventBus<ArgsRecord>>;
        entries(): IterableIterator<
            [Identifier, AnyEventSubscriberFrom<ArgsRecord>],
        >;
        getDispatcher(): EventDispatcher;
        getMeta(): Readonly<Metadata> | null;
        getMetadataFactory(): MetadataFactory;
        getSubscribedEvents(): ReadonlyCollection<string>;
        getSubscribers(): ReadonlyCollection<
            Identifier,
            AnyEventSubscriberFrom<ArgsRecord>,
        >;
        isSubscribed(subscriber: AnyEventSubscriberFrom<ArgsRecord>): boolean;
        keys(): IterableIterator<Identifier>;
        next(
            ...__namedParameters: [] | [any],
        ): IteratorResult<[Identifier, AnyEventSubscriberFrom<ArgsRecord>], any>;
        return?(
            value?: any,
        ): IteratorResult<[Identifier, AnyEventSubscriberFrom<ArgsRecord>], any>;
        setDispatcher(dispatcher: EventDispatcher): this;
        sortSubscribers(
            comparator: Comparator<Identifier, AnyEventSubscriberFrom<ArgsRecord>>,
        ): this;
        subscribe(
            ...subscribers: AnyEventSubscriberFrom<ArgsRecord>[],
        ): Awaitable<EventBus<ArgsRecord>>;
        throw?(
            e?: any,
        ): IteratorResult<[Identifier, AnyEventSubscriberFrom<ArgsRecord>], any>;
        unsubscribe(
            subscriber: AnyEventSubscriberFrom<ArgsRecord>,
        ): Awaitable<EventBus<ArgsRecord>>;
        unsubscribeProtected(
            subscriber: AnyEventSubscriberFrom<ArgsRecord>,
        ): Awaitable<EventBus<ArgsRecord>>;
        values(): IterableIterator<AnyEventSubscriberFrom<ArgsRecord>>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index