Class Client

Stoat.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 };
            legal_links: {
                guidelines: string;
                privacy_policy: string;
                terms_of_service: string;
            };
            limits: {
                default: {
                    bots: number;
                    file_upload_size_limits: { [key: string]: number };
                    message_attachments: number;
                    message_length: number;
                    outgoing_friend_requests: number;
                    servers: number;
                    video: boolean;
                    video_aspect_ratio: number[];
                    video_resolution: number[];
                    voice_quality: number;
                };
                global: {
                    body_limit_size: number;
                    group_size: number;
                    message_embeds: number;
                    message_reactions: number;
                    message_replies: number;
                    new_user_hours: number;
                    restrict_server_creation: string[];
                    server_channels: number;
                    server_emoji: number;
                    server_roles: number;
                };
                new_user: {
                    bots: number;
                    file_upload_size_limits: { [key: string]: number };
                    message_attachments: number;
                    message_length: number;
                    outgoing_friend_requests: number;
                    servers: number;
                    video: boolean;
                    video_aspect_ratio: number[];
                    video_resolution: number[];
                    voice_quality: number;
                };
            };
            livekit: {
                enabled: boolean;
                nodes: { lat: number; lon: number; name: string; public_url: string }[];
            };
        };
        revolt: string;
        vapid: string;
        ws: string;
    },
): Client
Create Stoat.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 };
          legal_links: {
              guidelines: string;
              privacy_policy: string;
              terms_of_service: string;
          };
          limits: {
              default: {
                  bots: number;
                  file_upload_size_limits: { [key: string]: number };
                  message_attachments: number;
                  message_length: number;
                  outgoing_friend_requests: number;
                  servers: number;
                  video: boolean;
                  video_aspect_ratio: number[];
                  video_resolution: number[];
                  voice_quality: number;
              };
              global: {
                  body_limit_size: number;
                  group_size: number;
                  message_embeds: number;
                  message_reactions: number;
                  message_replies: number;
                  new_user_hours: number;
                  restrict_server_creation: string[];
                  server_channels: number;
                  server_emoji: number;
                  server_roles: number;
              };
              new_user: {
                  bots: number;
                  file_upload_size_limits: { [key: string]: number };
                  message_attachments: number;
                  message_length: number;
                  outgoing_friend_requests: number;
                  servers: number;
                  video: boolean;
                  video_aspect_ratio: number[];
                  video_resolution: number[];
                  voice_quality: number;
              };
          };
          livekit: {
              enabled: boolean;
              nodes: { lat: number; lon: number; name: string; public_url: string }[];
          };
      };
      revolt: string;
      vapid: string;
      ws: string;
  }
  Deprecated - Please use Client.initConfig if you need to override config.
  - 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 };
        legal_links: {
            guidelines: string;
            privacy_policy: string;
            terms_of_service: string;
        };
        limits: {
            default: {
                bots: number;
                file_upload_size_limits: { [key: string]: number };
                message_attachments: number;
                message_length: number;
                outgoing_friend_requests: number;
                servers: number;
                video: boolean;
                video_aspect_ratio: number[];
                video_resolution: number[];
                voice_quality: number;
            };
            global: {
                body_limit_size: number;
                group_size: number;
                message_embeds: number;
                message_reactions: number;
                message_replies: number;
                new_user_hours: number;
                restrict_server_creation: string[];
                server_channels: number;
                server_emoji: number;
                server_roles: number;
            };
            new_user: {
                bots: number;
                file_upload_size_limits: { [key: string]: number };
                message_attachments: number;
                message_length: number;
                outgoing_friend_requests: number;
                servers: number;
                video: boolean;
                video_aspect_ratio: number[];
                video_resolution: number[];
                voice_quality: number;
            };
        };
        livekit: {
            enabled: boolean;
            nodes: { lat: number; lon: number; name: string; public_url: 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
    
    legal_links: { guidelines: string; privacy_policy: string; terms_of_service: string }
    Description
    Legal links
    
    guidelines: string
    Description
    Guidelines URL
    
    privacy_policy: string
    Description
    Privacy Policy URL
    
    terms_of_service: string
    Description
    Terms of Service URL
    
    limits: {
        default: {
            bots: number;
            file_upload_size_limits: { [key: string]: number };
            message_attachments: number;
            message_length: number;
            outgoing_friend_requests: number;
            servers: number;
            video: boolean;
            video_aspect_ratio: number[];
            video_resolution: number[];
            voice_quality: number;
        };
        global: {
            body_limit_size: number;
            group_size: number;
            message_embeds: number;
            message_reactions: number;
            message_replies: number;
            new_user_hours: number;
            restrict_server_creation: string[];
            server_channels: number;
            server_emoji: number;
            server_roles: number;
        };
        new_user: {
            bots: number;
            file_upload_size_limits: { [key: string]: number };
            message_attachments: number;
            message_length: number;
            outgoing_friend_requests: number;
            servers: number;
            video: boolean;
            video_aspect_ratio: number[];
            video_resolution: number[];
            voice_quality: number;
        };
    }
    Description
    Limits
    
    default: {
        bots: number;
        file_upload_size_limits: { [key: string]: number };
        message_attachments: number;
        message_length: number;
        outgoing_friend_requests: number;
        servers: number;
        video: boolean;
        video_aspect_ratio: number[];
        video_resolution: number[];
        voice_quality: number;
    }
    Description
    Default User Limits
    
    bots: number
    Format: int64
    
    Description
    Max Owned Bots
    
    file_upload_size_limits: { [key: string]: number }
    message_attachments: number
    Format: int64
    
    Description
    max message attachments
    
    message_length: number
    Format: int64
    
    Description
    Max message content length
    
    outgoing_friend_requests: number
    Format: int64
    
    Description
    Max Outgoing Friend Requests
    
    servers: number
    Format: int64
    
    Description
    max servers
    
    video: boolean
    Description
    video streaming enabled
    
    video_aspect_ratio: number[]
    Description
    min/max aspect ratios
    
    video_resolution: number[]
    Description
    max video resolution (vertical, horizontal)
    
    voice_quality: number
    Format: int64
    
    Description
    max audio quality
    
    global: {
        body_limit_size: number;
        group_size: number;
        message_embeds: number;
        message_reactions: number;
        message_replies: number;
        new_user_hours: number;
        restrict_server_creation: string[];
        server_channels: number;
        server_emoji: number;
        server_roles: number;
    }
    Description
    Global Limits
    
    body_limit_size: number
    Format: int64
    
    group_size: number
    Format: int64
    
    Description
    max group size
    
    message_embeds: number
    Format: int64
    
    Description
    max message embeds
    
    message_reactions: number
    Format: int64
    
    Description
    max reactions per message
    
    message_replies: number
    Format: int64
    
    Description
    max replies
    
    new_user_hours: number
    Format: int64
    
    Description
    New user hours
    
    restrict_server_creation: string[]
    Description
    restrict server creation to these users. if blank, all users can create servers
    
    server_channels: number
    Format: int64
    
    Description
    max server channels
    
    server_emoji: number
    Format: int64
    
    Description
    max server emoji
    
    server_roles: number
    Format: int64
    
    Description
    max server roles
    
    new_user: {
        bots: number;
        file_upload_size_limits: { [key: string]: number };
        message_attachments: number;
        message_length: number;
        outgoing_friend_requests: number;
        servers: number;
        video: boolean;
        video_aspect_ratio: number[];
        video_resolution: number[];
        voice_quality: number;
    }
    Description
    New User Limits
    
    bots: number
    Format: int64
    
    Description
    Max Owned Bots
    
    file_upload_size_limits: { [key: string]: number }
    message_attachments: number
    Format: int64
    
    Description
    max message attachments
    
    message_length: number
    Format: int64
    
    Description
    Max message content length
    
    outgoing_friend_requests: number
    Format: int64
    
    Description
    Max Outgoing Friend Requests
    
    servers: number
    Format: int64
    
    Description
    max servers
    
    video: boolean
    Description
    video streaming enabled
    
    video_aspect_ratio: number[]
    Description
    min/max aspect ratios
    
    video_resolution: number[]
    Description
    max video resolution (vertical, horizontal)
    
    voice_quality: number
    Format: int64
    
    Description
    max audio quality
    
    livekit: {
        enabled: boolean;
        nodes: { lat: number; lon: number; name: string; public_url: string }[];
    }
    Description
    Voice server configuration
    
    enabled: boolean
    Description
    Whether voice is enabled
    
    nodes: { lat: number; lon: number; name: string; public_url: string }[]
    Description
    All livekit nodes
  - 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:224

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

`Readonly`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 };
            legal_links: {
                guidelines: string;
                privacy_policy: string;
                terms_of_service: string;
            };
            limits: {
                default: {
                    bots: number;
                    file_upload_size_limits: { [key: string]: number };
                    message_attachments: number;
                    message_length: number;
                    outgoing_friend_requests: number;
                    servers: number;
                    video: boolean;
                    video_aspect_ratio: number[];
                    video_resolution: number[];
                    voice_quality: number;
                };
                global: {
                    body_limit_size: number;
                    group_size: number;
                    message_embeds: number;
                    message_reactions: number;
                    message_replies: number;
                    new_user_hours: number;
                    restrict_server_creation: string[];
                    server_channels: number;
                    server_emoji: number;
                    server_roles: number;
                };
                new_user: {
                    bots: number;
                    file_upload_size_limits: { [key: string]: number };
                    message_attachments: number;
                    message_length: number;
                    outgoing_friend_requests: number;
                    servers: number;
                    video: boolean;
                    video_aspect_ratio: number[];
                    video_resolution: number[];
                    voice_quality: number;
                };
            };
            livekit: {
                enabled: boolean;
                nodes: { lat: number; lon: number; name: string; public_url: 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 };
        legal_links: {
            guidelines: string;
            privacy_policy: string;
            terms_of_service: string;
        };
        limits: {
            default: {
                bots: number;
                file_upload_size_limits: { [key: string]: number };
                message_attachments: number;
                message_length: number;
                outgoing_friend_requests: number;
                servers: number;
                video: boolean;
                video_aspect_ratio: number[];
                video_resolution: number[];
                voice_quality: number;
            };
            global: {
                body_limit_size: number;
                group_size: number;
                message_embeds: number;
                message_reactions: number;
                message_replies: number;
                new_user_hours: number;
                restrict_server_creation: string[];
                server_channels: number;
                server_emoji: number;
                server_roles: number;
            };
            new_user: {
                bots: number;
                file_upload_size_limits: { [key: string]: number };
                message_attachments: number;
                message_length: number;
                outgoing_friend_requests: number;
                servers: number;
                video: boolean;
                video_aspect_ratio: number[];
                video_resolution: number[];
                voice_quality: number;
            };
        };
        livekit: {
            enabled: boolean;
            nodes: { lat: number; lon: number; name: string; public_url: 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 };
      legal_links: {
          guidelines: string;
          privacy_policy: string;
          terms_of_service: string;
      };
      limits: {
          default: {
              bots: number;
              file_upload_size_limits: { [key: string]: number };
              message_attachments: number;
              message_length: number;
              outgoing_friend_requests: number;
              servers: number;
              video: boolean;
              video_aspect_ratio: number[];
              video_resolution: number[];
              voice_quality: number;
          };
          global: {
              body_limit_size: number;
              group_size: number;
              message_embeds: number;
              message_reactions: number;
              message_replies: number;
              new_user_hours: number;
              restrict_server_creation: string[];
              server_channels: number;
              server_emoji: number;
              server_roles: number;
          };
          new_user: {
              bots: number;
              file_upload_size_limits: { [key: string]: number };
              message_attachments: number;
              message_length: number;
              outgoing_friend_requests: number;
              servers: number;
              video: boolean;
              video_aspect_ratio: number[];
              video_resolution: number[];
              voice_quality: number;
          };
      };
      livekit: {
          enabled: boolean;
          nodes: { lat: number; lon: number; name: string; public_url: 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
  - legal_links: { guidelines: string; privacy_policy: string; terms_of_service: string }
    Description
    Legal links
    - guidelines: string
      Description
      Guidelines URL
    - privacy_policy: string
      Description
      Privacy Policy URL
    - terms_of_service: string
      Description
      Terms of Service URL
  - limits: {
        default: {
            bots: number;
            file_upload_size_limits: { [key: string]: number };
            message_attachments: number;
            message_length: number;
            outgoing_friend_requests: number;
            servers: number;
            video: boolean;
            video_aspect_ratio: number[];
            video_resolution: number[];
            voice_quality: number;
        };
        global: {
            body_limit_size: number;
            group_size: number;
            message_embeds: number;
            message_reactions: number;
            message_replies: number;
            new_user_hours: number;
            restrict_server_creation: string[];
            server_channels: number;
            server_emoji: number;
            server_roles: number;
        };
        new_user: {
            bots: number;
            file_upload_size_limits: { [key: string]: number };
            message_attachments: number;
            message_length: number;
            outgoing_friend_requests: number;
            servers: number;
            video: boolean;
            video_aspect_ratio: number[];
            video_resolution: number[];
            voice_quality: number;
        };
    }
    Description
    Limits
    - default: {
          bots: number;
          file_upload_size_limits: { [key: string]: number };
          message_attachments: number;
          message_length: number;
          outgoing_friend_requests: number;
          servers: number;
          video: boolean;
          video_aspect_ratio: number[];
          video_resolution: number[];
          voice_quality: number;
      }
      Description
      Default User Limits
      - bots: number
        Format: int64
        
        Description
        Max Owned Bots
      - file_upload_size_limits: { [key: string]: number }
      - message_attachments: number
        Format: int64
        
        Description
        max message attachments
      - message_length: number
        Format: int64
        
        Description
        Max message content length
      - outgoing_friend_requests: number
        Format: int64
        
        Description
        Max Outgoing Friend Requests
      - servers: number
        Format: int64
        
        Description
        max servers
      - video: boolean
        Description
        video streaming enabled
      - video_aspect_ratio: number[]
        Description
        min/max aspect ratios
      - video_resolution: number[]
        Description
        max video resolution (vertical, horizontal)
      - voice_quality: number
        Format: int64
        
        Description
        max audio quality
    - global: {
          body_limit_size: number;
          group_size: number;
          message_embeds: number;
          message_reactions: number;
          message_replies: number;
          new_user_hours: number;
          restrict_server_creation: string[];
          server_channels: number;
          server_emoji: number;
          server_roles: number;
      }
      Description
      Global Limits
      - body_limit_size: number
        Format: int64
      - group_size: number
        Format: int64
        
        Description
        max group size
      - message_embeds: number
        Format: int64
        
        Description
        max message embeds
      - message_reactions: number
        Format: int64
        
        Description
        max reactions per message
      - message_replies: number
        Format: int64
        
        Description
        max replies
      - new_user_hours: number
        Format: int64
        
        Description
        New user hours
      - restrict_server_creation: string[]
        Description
        restrict server creation to these users. if blank, all users can create servers
      - server_channels: number
        Format: int64
        
        Description
        max server channels
      - server_emoji: number
        Format: int64
        
        Description
        max server emoji
      - server_roles: number
        Format: int64
        
        Description
        max server roles
    - new_user: {
          bots: number;
          file_upload_size_limits: { [key: string]: number };
          message_attachments: number;
          message_length: number;
          outgoing_friend_requests: number;
          servers: number;
          video: boolean;
          video_aspect_ratio: number[];
          video_resolution: number[];
          voice_quality: number;
      }
      Description
      New User Limits
      - bots: number
        Format: int64
        
        Description
        Max Owned Bots
      - file_upload_size_limits: { [key: string]: number }
      - message_attachments: number
        Format: int64
        
        Description
        max message attachments
      - message_length: number
        Format: int64
        
        Description
        Max message content length
      - outgoing_friend_requests: number
        Format: int64
        
        Description
        Max Outgoing Friend Requests
      - servers: number
        Format: int64
        
        Description
        max servers
      - video: boolean
        Description
        video streaming enabled
      - video_aspect_ratio: number[]
        Description
        min/max aspect ratios
      - video_resolution: number[]
        Description
        max video resolution (vertical, horizontal)
      - voice_quality: number
        Format: int64
        
        Description
        max audio quality
  - livekit: {
    enabled: boolean;
    nodes: { lat: number; lon: number; name: string; public_url: string }[];
    }
    Description
    Voice server configuration
    - enabled: boolean
      Description
      Whether voice is enabled
    - nodes: { lat: number; lon: number; name: string; public_url: string }[]
      Description
      All livekit nodes
- revolt: string
  Description
  Revolt API Version
- vapid: string
  Description
  Web Push VAPID public key
- ws: string
  Description
  WebSocket URL

`Readonly`configured

configured: Accessor<boolean>

`Readonly`connectionFailureCount

connectionFailureCount: Accessor<number>

`Readonly`emojis

emojis: EmojiCollection

`Readonly`entitlements

entitlements: Accessor<Entitlement[]>

Entitlements the current user holds, as last sent by the server. Note that passing an expiration date will NOT remove its data, so you may need to keep track of expiration yourself.

`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:346

limits

get limits(): | undefined
| {
    bots: number;
    file_upload_size_limits: { [key: string]: number };
    message_attachments: number;
    message_length: number;
    outgoing_friend_requests: number;
    servers: number;
    video: boolean;
    video_aspect_ratio: number[];
    video_resolution: number[];
    voice_quality: number;
}
Backend enforced limits for the logged in user

Returns
    | undefined
    | {
        bots: number;
        file_upload_size_limits: { [key: string]: number };
        message_attachments: number;
        message_length: number;
        outgoing_friend_requests: number;
        servers: number;
        video: boolean;
        video_aspect_ratio: number[];
        video_resolution: number[];
        voice_quality: number;
    }
- undefined
- {
      bots: number;
      file_upload_size_limits: { [key: string]: number };
      message_attachments: number;
      message_length: number;
      outgoing_friend_requests: number;
      servers: number;
      video: boolean;
      video_aspect_ratio: number[];
      video_resolution: number[];
      voice_quality: number;
  }
  - bots: number
    Format: int64
    
    Description
    Max Owned Bots
  - file_upload_size_limits: { [key: string]: number }
  - message_attachments: number
    Format: int64
    
    Description
    max message attachments
  - message_length: number
    Format: int64
    
    Description
    Max message content length
  - outgoing_friend_requests: number
    Format: int64
    
    Description
    Max Outgoing Friend Requests
  - servers: number
    Format: int64
    
    Description
    max servers
  - video: boolean
    Description
    video streaming enabled
  - video_aspect_ratio: number[]
    Description
    min/max aspect ratios
  - video_resolution: number[]
    Description
    max video resolution (vertical, horizontal)
  - voice_quality: number
    Format: int64
    
    Description
    max audio quality
- Defined in src/Client.ts:644

sessionId

get sessionId(): undefined | string
Current session id

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

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:19
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:20

connect

connect(): void
Connect to Revolt

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

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:39
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:40

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:47

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from AsyncEventEmitter.getMaxListeners
- Defined in node_modules/.pnpm/@vladfrangu+async_event_emitter@2.4.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:34

initConfig

initConfig(
    preConfig?: (
        config: {
            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 };
                legal_links: {
                    guidelines: string;
                    privacy_policy: string;
                    terms_of_service: string;
                };
                limits: {
                    default: {
                        bots: number;
                        file_upload_size_limits: { [key: string]: number };
                        message_attachments: number;
                        message_length: number;
                        outgoing_friend_requests: number;
                        servers: number;
                        video: boolean;
                        video_aspect_ratio: number[];
                        video_resolution: number[];
                        voice_quality: number;
                    };
                    global: {
                        body_limit_size: number;
                        group_size: number;
                        message_embeds: number;
                        message_reactions: number;
                        message_replies: number;
                        new_user_hours: number;
                        restrict_server_creation: string[];
                        server_channels: number;
                        server_emoji: number;
                        server_roles: number;
                    };
                    new_user: {
                        bots: number;
                        file_upload_size_limits: { [key: string]: number };
                        message_attachments: number;
                        message_length: number;
                        outgoing_friend_requests: number;
                        servers: number;
                        video: boolean;
                        video_aspect_ratio: number[];
                        video_resolution: number[];
                        voice_quality: number;
                    };
                };
                livekit: {
                    enabled: boolean;
                    nodes: { lat: number; lon: number; name: string; public_url: string }[];
                };
            };
            revolt: string;
            vapid: string;
            ws: string;
        },
    ) => void,
): Promise<void>
Fetches the server config. This is called automatically by login() or loginBot(), but you can call it first manually if you need to override any config options.

Override example:
```
await client.initConfig((config) => {
  config.ws = "wss://example.com";
});
```
Parameters
- OptionalpreConfig: (
      config: {
          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 };
              legal_links: {
                  guidelines: string;
                  privacy_policy: string;
                  terms_of_service: string;
              };
              limits: {
                  default: {
                      bots: number;
                      file_upload_size_limits: { [key: string]: number };
                      message_attachments: number;
                      message_length: number;
                      outgoing_friend_requests: number;
                      servers: number;
                      video: boolean;
                      video_aspect_ratio: number[];
                      video_resolution: number[];
                      voice_quality: number;
                  };
                  global: {
                      body_limit_size: number;
                      group_size: number;
                      message_embeds: number;
                      message_reactions: number;
                      message_replies: number;
                      new_user_hours: number;
                      restrict_server_creation: string[];
                      server_channels: number;
                      server_emoji: number;
                      server_roles: number;
                  };
                  new_user: {
                      bots: number;
                      file_upload_size_limits: { [key: string]: number };
                      message_attachments: number;
                      message_length: number;
                      outgoing_friend_requests: number;
                      servers: number;
                      video: boolean;
                      video_aspect_ratio: number[];
                      video_resolution: number[];
                      voice_quality: number;
                  };
              };
              livekit: {
                  enabled: boolean;
                  nodes: { lat: number; lon: number; name: string; public_url: string }[];
              };
          };
          revolt: string;
          vapid: string;
          ws: string;
      },
  ) => void
Returns Promise<void>
- Defined in src/Client.ts:375

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:41
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:42

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:35
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:36

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:406

loginBot

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

logout

logout(): Promise<void>
Log out of current session

This function prepares the client for disposal by removing all event listeners and killing the events socket.

Returns Promise<void>
- Defined in src/Client.ts:441

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:462

markdownToTextFetch

markdownToTextFetch(source: string): Promise<string>
Prepare a markdown-based message to be displayed to the user as plain text. This method will fetch each user or channel if they are missing. Useful for serviceworkers.
Parameters
- source: string
  Source markdown text
Returns Promise<string>
Modified plain text
- Defined in src/Client.ts:499

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:27
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:28

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:21
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:22

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:23
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:24

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:43
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:44

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:45
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:46

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:602

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:37
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:38

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:29
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:30
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:31
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:32

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:25
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:26

setEntitlements

setEntitlements(entitlements: Entitlement[]): void
Internal
Replace the current user's entitlements, from the events socket
Parameters
- entitlements: Entitlement[]
Returns void
- Defined in src/Client.ts:453

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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:33

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:618

useExistingSession

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

waitForAllListenersToComplete

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

`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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:51
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:52

`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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:55
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:56

`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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:53
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.7/node_modules/@vladfrangu/async_event_emitter/dist/index.d.mts:54

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

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

legal_links: { guidelines: string; privacy_policy: string; terms_of_service: string }

Description

guidelines: string

Description

privacy_policy: string

Description

terms_of_service: string

Description

Description

default: { bots: number; file_upload_size_limits: { [key: string]: number }; message_attachments: number; message_length: number; outgoing_friend_requests: number; servers: number; video: boolean; video_aspect_ratio: number[]; video_resolution: number[]; voice_quality: number;}

Description

bots: number

Description

file_upload_size_limits: { [key: string]: number }

message_attachments: number

Description

message_length: number

Description

outgoing_friend_requests: number

Description

servers: number

Description

video: boolean

Description

video_aspect_ratio: number[]

Description

video_resolution: number[]

Description

voice_quality: number

Description

global: { body_limit_size: number; group_size: number; message_embeds: number; message_reactions: number; message_replies: number; new_user_hours: number; restrict_server_creation: string[]; server_channels: number; server_emoji: number; server_roles: number;}

Description

body_limit_size: number

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

default: {
bots: number;
file_upload_size_limits: { [key: string]: number };
message_attachments: number;
message_length: number;
outgoing_friend_requests: number;
servers: number;
video: boolean;
video_aspect_ratio: number[];
video_resolution: number[];
voice_quality: number;
}

global: {
body_limit_size: number;
group_size: number;
message_embeds: number;
message_reactions: number;
message_replies: number;
new_user_hours: number;
restrict_server_creation: string[];
server_channels: number;
server_emoji: number;
server_roles: number;
}

new_user: {
bots: number;
file_upload_size_limits: { [key: string]: number };
message_attachments: number;
message_length: number;
outgoing_friend_requests: number;
servers: number;
video: boolean;
video_aspect_ratio: number[];
video_resolution: number[];
voice_quality: number;
}

livekit: {
enabled: boolean;
nodes: { lat: number; lon: number; name: string; public_url: string }[];
}

`Protected` `Readonly`[brandSymbol]

`Readonly`account

`Readonly`api

`Readonly`bots

`Readonly`channels

`Readonly`channelUnreads

`Readonly`channelWebhooks

`Readonly`configuration

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