nyx Typedoc
    Preparing search index...

    Interface EventEmitterBus<EventArgsObject, Emitter>

    An EventBus whose events are emitted by an EventEmitter.

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

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index