nyx Typedoc
    Preparing search index...

    Interface EventSubscriber<ArgsRecord, Event>

    An object that can subscribe to a event on an EventBus.

    interface EventSubscriber<
        ArgsRecord extends Record<keyof ArgsRecord & string, unknown[]>,
        Event extends keyof ArgsRecord & string = keyof ArgsRecord & string,
    > {
        getEvent(): Event;
        getFilter(): EventSubscriberFilterResolvable<ArgsRecord, Event> | null;
        getId(): Identifier;
        getLifetime(): EventSubscriberLifetime;
        getMeta(): Readonly<Metadata> | null;
        getPriority(): Priority;
        handleEvent(meta: Metadata, ...args: ArgsRecord[Event]): Awaitable<void>;
        ignoresHandledEvents(): boolean;
        isProtected(): boolean;
        onBusUnregister(bus: EventBus<ArgsRecord>): Awaitable<void>;
        onSubscribe(bus: EventBus<ArgsRecord>): Awaitable<void>;
        onUnsubscribe(bus: EventBus<ArgsRecord>): Awaitable<void>;
        protect(): this;
        unprotect(): this;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index