Class Client

Revolt.js Clients

Hierarchy

AsyncEventEmitter<Events>
- Client

Constructors

constructor

new Client(
    options?: Partial<ClientOptions>,
    configuration?: {
        app: string;
        build: {
            commit_sha: string;
            commit_timestamp: string;
            origin_url: string;
            semver: string;
            timestamp: string;
        };
        features: {
            autumn: { enabled: boolean; url: string };
            captcha: { enabled: boolean; key: string };
            email: boolean;
            invite_only: boolean;
            january: { enabled: boolean; url: string };
            voso: { enabled: boolean; url: string; ws: string };
        };
        revolt: string;
        vapid: string;
        ws: string;
    },
): Client
Create Revolt.js Client
Parameters
- Optionaloptions: Partial<ClientOptions>
- Optionalconfiguration: {
      app: string;
      build: {
          commit_sha: string;
          commit_timestamp: string;
          origin_url: string;
          semver: string;
          timestamp: string;
      };
      features: {
          autumn: { enabled: boolean; url: string };
          captcha: { enabled: boolean; key: string };
          email: boolean;
          invite_only: boolean;
          january: { enabled: boolean; url: string };
          voso: { enabled: boolean; url: string; ws: string };
      };
      revolt: string;
      vapid: string;
      ws: string;
  }
  - app: string
    Description
    URL pointing to the client serving this node
  - build: {
        commit_sha: string;
        commit_timestamp: string;
        origin_url: string;
        semver: string;
        timestamp: string;
    }
    Description
    Build information
    
    commit_sha: string
    Description
    Commit Hash
    
    commit_timestamp: string
    Description
    Commit Timestamp
    
    origin_url: string
    Description
    Git Origin URL
    
    semver: string
    Description
    Git Semver
    
    timestamp: string
    Description
    Build Timestamp
  - features: {
        autumn: { enabled: boolean; url: string };
        captcha: { enabled: boolean; key: string };
        email: boolean;
        invite_only: boolean;
        january: { enabled: boolean; url: string };
        voso: { enabled: boolean; url: string; ws: string };
    }
    Description
    Features enabled on this Revolt node
    
    autumn: { enabled: boolean; url: string }
    Description
    File server service configuration
    
    enabled: boolean
    Description
    Whether the service is enabled
    
    url: string
    Description
    URL pointing to the service
    
    captcha: { enabled: boolean; key: string }
    Description
    hCaptcha configuration
    
    enabled: boolean
    Description
    Whether captcha is enabled
    
    key: string
    Description
    Client key used for solving captcha
    
    email: boolean
    Description
    Whether email verification is enabled
    
    invite_only: boolean
    Description
    Whether this server is invite only
    
    january: { enabled: boolean; url: string }
    Description
    Proxy service configuration
    
    enabled: boolean
    Description
    Whether the service is enabled
    
    url: string
    Description
    URL pointing to the service
    
    voso: { enabled: boolean; url: string; ws: string }
    Description
    Voice server configuration
    
    enabled: boolean
    Description
    Whether voice is enabled
    
    url: string
    Description
    URL pointing to the voice API
    
    ws: string
    Description
    URL pointing to the voice WebSocket server
  - revolt: string
    Description
    Revolt API Version
  - vapid: string
    Description
    Web Push VAPID public key
  - ws: string
    Description
    WebSocket URL
Returns Client
Overrides AsyncEventEmitter<Events>.constructor
- Defined in src/Client.ts:198

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

`Readonly`account

account: AccountCollection

configuration

configuration:
    | undefined
    | {
        app: string;
        build: {
            commit_sha: string;
            commit_timestamp: string;
            origin_url: string;
            semver: string;
            timestamp: string;
        };
        features: {
            autumn: { enabled: boolean; url: string };
            captcha: { enabled: boolean; key: string };
            email: boolean;
            invite_only: boolean;
            january: { enabled: boolean; url: string };
            voso: { enabled: boolean; url: string; ws: string };
        };
        revolt: string;
        vapid: string;
        ws: string;
    }

Type declaration

undefined
{
    app: string;
    build: {
        commit_sha: string;
        commit_timestamp: string;
        origin_url: string;
        semver: string;
        timestamp: string;
    };
    features: {
        autumn: { enabled: boolean; url: string };
        captcha: { enabled: boolean; key: string };
        email: boolean;
        invite_only: boolean;
        january: { enabled: boolean; url: string };
        voso: { enabled: boolean; url: string; ws: string };
    };
    revolt: string;
    vapid: string;
    ws: string;
}
- app: string
  Description
  URL pointing to the client serving this node
- build: {
      commit_sha: string;
      commit_timestamp: string;
      origin_url: string;
      semver: string;
      timestamp: string;
  }
  Description
  Build information
  - commit_sha: string
    Description
    Commit Hash
  - commit_timestamp: string
    Description
    Commit Timestamp
  - origin_url: string
    Description
    Git Origin URL
  - semver: string
    Description
    Git Semver
  - timestamp: string
    Description
    Build Timestamp
- features: {
      autumn: { enabled: boolean; url: string };
      captcha: { enabled: boolean; key: string };
      email: boolean;
      invite_only: boolean;
      january: { enabled: boolean; url: string };
      voso: { enabled: boolean; url: string; ws: string };
  }
  Description
  Features enabled on this Revolt node
  - autumn: { enabled: boolean; url: string }
    Description
    File server service configuration
    - enabled: boolean
      Description
      Whether the service is enabled
    - url: string
      Description
      URL pointing to the service
  - captcha: { enabled: boolean; key: string }
    Description
    hCaptcha configuration
    - enabled: boolean
      Description
      Whether captcha is enabled
    - key: string
      Description
      Client key used for solving captcha
  - email: boolean
    Description
    Whether email verification is enabled
  - invite_only: boolean
    Description
    Whether this server is invite only
  - january: { enabled: boolean; url: string }
    Description
    Proxy service configuration
    - enabled: boolean
      Description
      Whether the service is enabled
    - url: string
      Description
      URL pointing to the service
  - voso: { enabled: boolean; url: string; ws: string }
    Description
    Voice server configuration
    - enabled: boolean
      Description
      Whether voice is enabled
    - url: string
      Description
      URL pointing to the voice API
    - ws: string
      Description
      URL pointing to the voice WebSocket server
- revolt: string
  Description
  Revolt API Version
- vapid: string
  Description
  Web Push VAPID public key
- ws: string
  Description
  WebSocket URL

`Readonly`connectionFailureCount

connectionFailureCount: Accessor<number>

`Readonly`emojis

emojis: EmojiCollection

`Readonly`events

events: EventClient<1>

`Readonly`messages

messages: MessageCollection

`Readonly`options

options: ClientOptions

`Readonly`ready

ready: Accessor<boolean>

`Readonly`serverMembers

serverMembers: ServerMemberCollection

`Readonly`servers

servers: ServerCollection

`Readonly`sessions

sessions: SessionCollection

user

user: undefined | User

`Readonly`users

users: UserCollection

Accessors

authenticationHeader

get authenticationHeader(): [string, string]
Get authentication header

Returns [string, string]
- Defined in src/Client.ts:306

sessionId

get sessionId(): undefined | string
Current session id

Returns undefined | string
- Defined in src/Client.ts:299

Methods

addListener

addListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.addListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17
addListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.addListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18

connect

connect(): void
Connect to Revolt

Returns void
- Defined in src/Client.ts:315

emit

emit<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<Events>,
        K,
    >,
): boolean
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>
Returns boolean
Inherited from AsyncEventEmitter.emit
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:37
emit<K extends string | symbol>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<Events>,
        K,
    >,
): boolean
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>
Returns boolean
Inherited from AsyncEventEmitter.emit
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:38

eventNames

eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof Events
)[]
Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof Events
)[]
Inherited from AsyncEventEmitter.eventNames
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:45

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from AsyncEventEmitter.getMaxListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:32

listenerCount

listenerCount<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    eventName: K,
): number
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:39
listenerCount(eventName: string | symbol): number
Parameters
- eventName: string | symbol
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:40

listeners

listeners<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Inherited from AsyncEventEmitter.listeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:33
listeners<K extends string | symbol>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Inherited from AsyncEventEmitter.listeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:34

login

login(
    details:
        | { email: string; friendly_name?: null
        | string; password: string }
        | {
            friendly_name?: null | string;
            mfa_response?:
                | null
                | { password: string }
                | { recovery_code: string }
                | { totp_code: string };
            mfa_ticket: string;
        },
): Promise<void>
Log in with auth data, creating a new session in the process.
Parameters
- details:
      | { email: string; friendly_name?: null
      | string; password: string }
      | {
          friendly_name?: null | string;
          mfa_response?:
              | null
              | { password: string }
              | { recovery_code: string }
              | { totp_code: string };
          mfa_ticket: string;
      }
  Login data object
  - { email: string; friendly_name?: null | string; password: string }
    email: string
    Description
    Email
    
    Optionalfriendly_name?: null | string
    Description
    Friendly name used for the session
    
    password: string
    Description
    Password
  - {
        friendly_name?: null | string;
        mfa_response?:
            | null
            | { password: string }
            | { recovery_code: string }
            | { totp_code: string };
        mfa_ticket: string;
    }
    Optionalfriendly_name?: null | string
    Description
    Friendly name used for the session
    
    Optionalmfa_response?: null | { password: string } | { recovery_code: string } | { totp_code: string }
    Description
    Valid MFA response
    
    This will take precedence over the password field where applicable
    
    mfa_ticket: string
    Description
    Unvalidated or authorised MFA ticket
    
    Used to resolve the correct account
Returns Promise<void>
An on-boarding function if on-boarding is required, undefined otherwise
- Defined in src/Client.ts:351

loginBot

loginBot(token: string): Promise<void>
Log in as a bot
Parameters
- token: string
  Bot token
Returns Promise<void>
- Defined in src/Client.ts:374

markdownToText

markdownToText(source: string): string
Prepare a markdown-based message to be displayed to the user as plain text.
Parameters
- source: string
  Source markdown text
Returns string
Modified plain text
- Defined in src/Client.ts:386

off

off<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.off
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:25
off<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.off
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:26

on

on<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.on
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:19
on<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.on
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:20

once

once<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.once
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:21
once<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.once
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:22

prependListener

prependListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:41
prependListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:42

prependOnceListener

prependOnceListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependOnceListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:43
prependOnceListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependOnceListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:44

proxyFile

proxyFile(url: string): undefined | string
Proxy a file through January.
Parameters
- url: string
  URL to proxy
Returns undefined | string
Proxied media URL
- Defined in src/Client.ts:414

rawListeners

rawListeners<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Inherited from AsyncEventEmitter.rawListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:35
rawListeners<K extends string | symbol>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Inherited from AsyncEventEmitter.rawListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:36

removeAllListeners

removeAllListeners<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    event: K,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- event: K
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27
removeAllListeners<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    event?: K,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- Optionalevent: K
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:28
removeAllListeners(event: string | symbol): this
Parameters
- event: string | symbol
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29
removeAllListeners(event?: string | symbol): this
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:30

removeListener

removeListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof Events),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.removeListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:23
removeListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.removeListener
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:24

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from AsyncEventEmitter.setMaxListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:31

uploadFile

uploadFile(tag: string, file: File, uploadUrl?: string): Promise<string>
Upload a file
Parameters
- tag: string
  Tag
- file: File
  File
- OptionaluploadUrl: string
  Media server upload route
Returns Promise<string>
- Defined in src/Client.ts:430

useExistingSession

useExistingSession(session: PrivateSession): void
Use an existing session
Parameters
- session: PrivateSession
Returns void
- Defined in src/Client.ts:365

waitForAllListenersToComplete

waitForAllListenersToComplete(): Promise<boolean>
Returns Promise<boolean>
Inherited from AsyncEventEmitter.waitForAllListenersToComplete
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:46

`Static`listenerCount

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
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:49
listenerCount(
emitter: AsyncEventEmitter<any>,
eventName: string | symbol,
): number
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:50

`Static`on

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,
>
Inherited from AsyncEventEmitter.on
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:53
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>
Inherited from AsyncEventEmitter.on
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:54

`Static`once

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,
    >,
>
Inherited from AsyncEventEmitter.once
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:51
once(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): Promise<any[]>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns Promise<any[]>
Inherited from AsyncEventEmitter.once
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.6/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:52

Class Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

app: string

Description

build: { commit_sha: string; commit_timestamp: string; origin_url: string; semver: string; timestamp: string;}

Description

commit_sha: string

Description

commit_timestamp: string

Description

origin_url: string

Description

semver: string

Description

timestamp: string

Description

features: { autumn: { enabled: boolean; url: string }; captcha: { enabled: boolean; key: string }; email: boolean; invite_only: boolean; january: { enabled: boolean; url: string }; voso: { enabled: boolean; url: string; ws: string };}

Description

autumn: { enabled: boolean; url: string }

Description

enabled: boolean

Description

url: string

Description

captcha: { enabled: boolean; key: string }

Description

enabled: boolean

Description

key: string

Description

email: boolean

Description

invite_only: boolean

Description

january: { enabled: boolean; url: string }

Description

enabled: boolean

Description

url: string

Description

voso: { enabled: boolean; url: string; ws: string }

Description

enabled: boolean

Description

url: string

Description

ws: string

Description

revolt: string

Description

vapid: string

Description

ws: string

Description

Returns Client

Properties

Protected Readonly[brandSymbol]

Readonlyaccount

Readonlyapi

Readonlybots

Readonlychannels

ReadonlychannelUnreads

ReadonlychannelWebhooks

configuration

Type declaration

app: string

Description

build: { commit_sha: string; commit_timestamp: string; origin_url: string; semver: string; timestamp: string;}

Description

commit_sha: string

Description

commit_timestamp: string

build: {
commit_sha: string;
commit_timestamp: string;
origin_url: string;
semver: string;
timestamp: string;
}

features: {
autumn: { enabled: boolean; url: string };
captcha: { enabled: boolean; key: string };
email: boolean;
invite_only: boolean;
january: { enabled: boolean; url: string };
voso: { enabled: boolean; url: string; ws: string };
}

`Protected` `Readonly`[brandSymbol]

`Readonly`account

`Readonly`api

`Readonly`bots

`Readonly`channels

`Readonly`channelUnreads

`Readonly`channelWebhooks

build: {
commit_sha: string;
commit_timestamp: string;
origin_url: string;
semver: string;
timestamp: string;
}

features: {
autumn: { enabled: boolean; url: string };
captcha: { enabled: boolean; key: string };
email: boolean;
invite_only: boolean;
january: { enabled: boolean; url: string };
voso: { enabled: boolean; url: string; ws: string };
}

`Readonly`connectionFailureCount

`Readonly`emojis

`Readonly`events

`Readonly`messages

`Readonly`options

`Readonly`ready

`Readonly`serverMembers

`Readonly`servers

`Readonly`sessions

`Readonly`users