Class EventClient<T>

Simple wrapper around the Revolt websocket service.

Type Parameters

  • T extends AvailableProtocols

Hierarchy

  • AsyncEventEmitter<Events<T, EventProtocol<T>>>
    • EventClient

Constructors

constructor

Properties

[brandSymbol] options ping state

Accessors

lastError

Methods

addListener connect disconnect emit eventNames getMaxListeners handle listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener send setMaxListeners waitForAllListenersToComplete listenerCount on once

Constructors

constructor

  • new EventClient<T extends 1>(
        protocolVersion: T,
        transportFormat?: "json",
        options?: Partial<EventClientOptions>,
    ): EventClient<T>

    Create a new event client.

    Type Parameters

    • T extends 1

    Parameters

    • protocolVersion: T

      Target protocol version

    • transportFormat: "json" = "json"

      Communication format

    • Optionaloptions: Partial<EventClientOptions>

      Configuration options

    Returns EventClient<T>

Properties

Protected Readonly[brandSymbol]

"[brandSymbol]": Events

This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

Readonlyoptions

options: EventClientOptions

Readonlyping

ping: Accessor<number>

Readonlystate

state: Accessor<ConnectionState>

Accessors

lastError

  • get lastError(): | undefined
    | { data: any; type: "socket" }
    | {
        data: (
            | { type: "LabelMe" }
            | { type: "AlreadyOnboarded" }
            | { type: "UsernameTaken" }
            | { type: "InvalidUsername" }
            | { type: "DiscriminatorChangeRatelimited" }
            | { type: "UnknownUser" }
            | { type: "AlreadyFriends" }
            | { type: "AlreadySentRequest" }
            | { type: "Blocked" }
            | { type: "BlockedByOther" }
            | { type: "NotFriends" }
            | { max: number; type: "TooManyPendingFriendRequests" }
            | { type: "UnknownChannel" }
            | { type: "UnknownAttachment" }
            | { type: "UnknownMessage" }
            | { type: "CannotEditMessage" }
            | { type: "CannotJoinCall" }
            | { max: number; type: "TooManyAttachments" }
            | { max: number; type: "TooManyEmbeds" }
            | { max: number; type: "TooManyReplies" }
            | { max: number; type: "TooManyChannels" }
            | { type: "EmptyMessage" }
            | { type: "PayloadTooLarge" }
            | { type: "CannotRemoveYourself" }
            | { max: number; type: "GroupTooLarge" }
            | { type: "AlreadyInGroup" }
            | { type: "NotInGroup" }
            | { type: "AlreadyPinned" }
            | { type: "NotPinned" }
            | { type: "UnknownServer" }
            | { type: "InvalidRole" }
            | { type: "Banned" }
            | { max: number; type: "TooManyServers" }
            | { max: number; type: "TooManyEmoji" }
            | { max: number; type: "TooManyRoles" }
            | { type: "AlreadyInServer" }
            | { type: "CannotTimeoutYourself" }
            | { type: "ReachedMaximumBots" }
            | { type: "IsBot" }
            | { type: "BotIsPrivate" }
            | { type: "CannotReportYourself" }
            | { permission: string; type: "MissingPermission" }
            | { permission: string; type: "MissingUserPermission" }
            | { type: "NotElevated" }
            | { type: "NotPrivileged" }
            | { type: "CannotGiveMissingPermissions" }
            | { type: "NotOwner" }
            | { collection: string; operation: string; type: "DatabaseError" }
            | { type: "InternalError" }
            | { type: "InvalidOperation" }
            | { type: "InvalidCredentials" }
            | { type: "InvalidProperty" }
            | { type: "InvalidSession" }
            | { type: "NotAuthenticated" }
            | { type: "DuplicateNonce" }
            | { type: "NotFound" }
            | { type: "NoEffect" }
            | { error: string; type: "FailedValidation" }
            | { type: "ProxyError" }
            | { type: "FileTooSmall" }
            | { max: number; type: "FileTooLarge" }
            | { type: "FileTypeNotAllowed" }
            | { type: "ImageProcessingFailed" }
            | { type: "NoEmbedData" }
            | { type: "VosoUnavailable" }
        ) & { location: string };
        type: "revolt";
    }

    Last error encountered by events client

    Returns
        | undefined
        | { data: any; type: "socket" }
        | {
            data: (
                | { type: "LabelMe" }
                | { type: "AlreadyOnboarded" }
                | { type: "UsernameTaken" }
                | { type: "InvalidUsername" }
                | { type: "DiscriminatorChangeRatelimited" }
                | { type: "UnknownUser" }
                | { type: "AlreadyFriends" }
                | { type: "AlreadySentRequest" }
                | { type: "Blocked" }
                | { type: "BlockedByOther" }
                | { type: "NotFriends" }
                | { max: number; type: "TooManyPendingFriendRequests" }
                | { type: "UnknownChannel" }
                | { type: "UnknownAttachment" }
                | { type: "UnknownMessage" }
                | { type: "CannotEditMessage" }
                | { type: "CannotJoinCall" }
                | { max: number; type: "TooManyAttachments" }
                | { max: number; type: "TooManyEmbeds" }
                | { max: number; type: "TooManyReplies" }
                | { max: number; type: "TooManyChannels" }
                | { type: "EmptyMessage" }
                | { type: "PayloadTooLarge" }
                | { type: "CannotRemoveYourself" }
                | { max: number; type: "GroupTooLarge" }
                | { type: "AlreadyInGroup" }
                | { type: "NotInGroup" }
                | { type: "AlreadyPinned" }
                | { type: "NotPinned" }
                | { type: "UnknownServer" }
                | { type: "InvalidRole" }
                | { type: "Banned" }
                | { max: number; type: "TooManyServers" }
                | { max: number; type: "TooManyEmoji" }
                | { max: number; type: "TooManyRoles" }
                | { type: "AlreadyInServer" }
                | { type: "CannotTimeoutYourself" }
                | { type: "ReachedMaximumBots" }
                | { type: "IsBot" }
                | { type: "BotIsPrivate" }
                | { type: "CannotReportYourself" }
                | { permission: string; type: "MissingPermission" }
                | { permission: string; type: "MissingUserPermission" }
                | { type: "NotElevated" }
                | { type: "NotPrivileged" }
                | { type: "CannotGiveMissingPermissions" }
                | { type: "NotOwner" }
                | { collection: string; operation: string; type: "DatabaseError" }
                | { type: "InternalError" }
                | { type: "InvalidOperation" }
                | { type: "InvalidCredentials" }
                | { type: "InvalidProperty" }
                | { type: "InvalidSession" }
                | { type: "NotAuthenticated" }
                | { type: "DuplicateNonce" }
                | { type: "NotFound" }
                | { type: "NoEffect" }
                | { error: string; type: "FailedValidation" }
                | { type: "ProxyError" }
                | { type: "FileTooSmall" }
                | { max: number; type: "FileTooLarge" }
                | { type: "FileTypeNotAllowed" }
                | { type: "ImageProcessingFailed" }
                | { type: "NoEmbedData" }
                | { type: "VosoUnavailable" }
            ) & { location: string };
            type: "revolt";
        }

Methods

addListener

  • addListener<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

  • addListener<K extends string | symbol>(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

connect

  • connect(uri: string, token: string): void

    Connect to the websocket service.

    Parameters

    • uri: string

      WebSocket URI

    • token: string

      Authentication token

    Returns void

disconnect

emit

  • emit<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        ...args: InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
        >,
    ): boolean

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • ...args: InternalGetAsyncEventEmitterEventParameters<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
      >

    Returns boolean

  • emit<K extends string | symbol>(
        eventName: K,
        ...args: InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
        >,
    ): boolean

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • ...args: InternalGetAsyncEventEmitterEventParameters<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
      >

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
        keyof Events<T, EventProtocol<T>>
    )[]

    Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
        keyof Events<T, EventProtocol<T>>
    )[]

getMaxListeners

  • getMaxListeners(): number

    Returns number

handle

  • handle(event: EventProtocol<T>["server"]): void

    Handle events intended for client before passing them along.

    Parameters

    • event: EventProtocol<T>["server"]

      Event

    Returns void

listenerCount

  • listenerCount<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
    ): number

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K

    Returns number

  • listenerCount(eventName: string | symbol): number

    Parameters

    • eventName: string | symbol

    Returns number

listeners

  • listeners<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
    ): Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
            Events<T, EventProtocol<T>>,
        >["listener"],
        undefined,
    >[]

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K

    Returns Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
            Events<T, EventProtocol<T>>,
        >["listener"],
        undefined,
    >[]

  • listeners<K extends string | symbol>(
        eventName: K,
    ): Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
            Events<T, EventProtocol<T>>,
        >["listener"],
        undefined,
    >[]

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K

    Returns Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
            Events<T, EventProtocol<T>>,
        >["listener"],
        undefined,
    >[]

off

  • off<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

  • off<K extends string | symbol>(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

on

  • on<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

  • on<K extends string | symbol>(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

once

  • once<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

  • once<K extends string | symbol>(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

prependListener

  • prependListener<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

  • prependListener<K extends string | symbol>(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

prependOnceListener

  • prependOnceListener<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

  • prependOnceListener<K extends string | symbol>(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

rawListeners

  • rawListeners<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
    ): InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events<T, EventProtocol<T>>>,
        K,
        Events<T, EventProtocol<T>>,
    >[]

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K

    Returns InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events<T, EventProtocol<T>>>,
        K,
        Events<T, EventProtocol<T>>,
    >[]

  • rawListeners<K extends string | symbol>(
        eventName: K,
    ): InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events<T, EventProtocol<T>>>,
        K,
        Events<T, EventProtocol<T>>,
    >[]

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K

    Returns InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events<T, EventProtocol<T>>>,
        K,
        Events<T, EventProtocol<T>>,
    >[]

removeAllListeners

  • removeAllListeners<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        event: K,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • event: K

    Returns this

  • removeAllListeners<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        event?: K,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • Optionalevent: K

    Returns this

  • removeAllListeners(event: string | symbol): this

    Parameters

    • event: string | symbol

    Returns this

  • removeAllListeners(event?: string | symbol): this

    Parameters

    • Optionalevent: string | symbol

    Returns this

removeListener

  • removeListener<
        K extends
            | (keyof AsyncEventEmitterPredefinedEvents)
            | (keyof Events<T, EventProtocol<T>>),
    >(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

  • removeListener<K extends string | symbol>(
        eventName: K,
        listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >,
    ): this

    Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >

    Returns this

send

  • send(event: EventProtocol<T>["client"]): void

    Send an event to the server.

    Parameters

    • event: EventProtocol<T>["client"]

      Event

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

    Parameters

    • n: number

    Returns this

waitForAllListenersToComplete

  • waitForAllListenersToComplete(): Promise<boolean>

    Returns Promise<boolean>

StaticlistenerCount

  • listenerCount<
        EventMap extends {},
        EventName extends
            PropertyKey =
            | (keyof AsyncEventEmitterPredefinedEvents)
            | keyof EventMap,
    >(
        emitter: AsyncEventEmitter<EventMap>,
        eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName,
    ): number

    Type Parameters

    • EventMap extends {}
    • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

    Parameters

    • emitter: AsyncEventEmitter<EventMap>
    • eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName

    Returns number

  • listenerCount(
        emitter: AsyncEventEmitter<any>,
        eventName: string | symbol,
    ): number

    Parameters

    • emitter: AsyncEventEmitter<any>
    • eventName: string | symbol

    Returns number

Staticon

  • on<
        EventMap extends {},
        EventName extends
            PropertyKey =
            | (keyof AsyncEventEmitterPredefinedEvents)
            | keyof EventMap,
    >(
        emitter: AsyncEventEmitter<EventMap>,
        eventName: EventName,
        options?: AbortableMethods,
    ): AsyncGenerator<
        InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<EventMap>,
            EventName,
            EventMap,
        >,
        void,
    >

    Type Parameters

    • EventMap extends {}
    • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

    Parameters

    • emitter: AsyncEventEmitter<EventMap>
    • eventName: EventName
    • Optionaloptions: AbortableMethods

    Returns AsyncGenerator<
        InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<EventMap>,
            EventName,
            EventMap,
        >,
        void,
    >

  • on(
        emitter: AsyncEventEmitter<any>,
        eventName: string | symbol,
        options?: AbortableMethods,
    ): AsyncGenerator<any[], void>

    Parameters

    • emitter: AsyncEventEmitter<any>
    • eventName: string | symbol
    • Optionaloptions: AbortableMethods

    Returns AsyncGenerator<any[], void>

Staticonce

  • once<
        EventMap extends {},
        EventName extends
            PropertyKey =
            | (keyof AsyncEventEmitterPredefinedEvents)
            | keyof EventMap,
    >(
        emitter: AsyncEventEmitter<EventMap>,
        eventName: EventName,
        options?: AbortableMethods,
    ): Promise<
        InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<EventMap>,
            EventName,
            EventMap,
        >,
    >

    Type Parameters

    • EventMap extends {}
    • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

    Parameters

    • emitter: AsyncEventEmitter<EventMap>
    • eventName: EventName
    • Optionaloptions: AbortableMethods

    Returns Promise<
        InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<EventMap>,
            EventName,
            EventMap,
        >,
    >

  • once(
        emitter: AsyncEventEmitter<any>,
        eventName: string | symbol,
        options?: AbortableMethods,
    ): Promise<any[]>

    Parameters

    • emitter: AsyncEventEmitter<any>
    • eventName: string | symbol
    • Optionaloptions: AbortableMethods

    Returns Promise<any[]>

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR