Class Client

Revolt.js Clients

Hierarchy

EventEmitter<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
- Optional options: Partial<ClientOptions>
- Optional 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;
  }
  - 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 EventEmitter<Events>.constructor
- Defined in src/Client.ts:179

Properties

`Private` #reconnectTimeout

#reconnectTimeout: undefined | number

`Private` #session

#session: undefined | PrivateSession

`Private` #setConnectionFailureCount

#setConnectionFailureCount: Setter<number>

`Private` #setReady

#setReady: Setter<boolean>

`Readonly` account

account: AccountCollection

`Readonly` api

api: API

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;
}

`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

`Static` prefixed

prefixed: string | boolean

Accessors

sessionId

get sessionId(): undefined | string
Current session id

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

Methods

`Private` #fetchConfiguration

#fetchConfiguration(): Promise<void>
Fetches the configuration of the server if it has not been already fetched.

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

`Private` #updateHeaders

#updateHeaders(): void
Update API object to use authentication.

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

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void), context?: any): Client
Type Parameters
- T extends keyof Events
Parameters
- event: T
- fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)
  - - (...args: ArgumentMap<Events>[Extract<T, keyof Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]
      
      Returns void
- Optional context: any
Returns Client
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:45

connect

connect(): void
Connect to Revolt

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

emit

emit<T>(event: T, ...args: ArgumentMap<Events>[Extract<T, keyof Events>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof Events
Parameters
- event: T
- Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof Events)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof Events)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: keyof Events): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof Events
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof Events
Parameters
- event: T
Returns ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:20

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.

Returns
An on-boarding function if on-boarding is required, undefined otherwise
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
Returns Promise<void>
- Defined in src/Client.ts:313

loginBot

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

markdownToText

markdownToText(source: string): string
Prepare a markdown-based message to be displayed to the user as plain text.

Returns
Modified plain text
Parameters
- source: string
  
  Source markdown text
Returns string
- Defined in src/Client.ts:352

off

off<T>(event: T, fn?: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void), context?: any, once?: boolean): Client
Type Parameters
- T extends keyof Events
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)
  - - (...args: ArgumentMap<Events>[Extract<T, keyof Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Client
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void), context?: any): Client
Add a listener for a given event.
Type Parameters
- T extends keyof Events
Parameters
- event: T
- fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)
  - - (...args: ArgumentMap<Events>[Extract<T, keyof Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]
      
      Returns void
- Optional context: any
Returns Client
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void), context?: any): Client
Add a one-time listener for a given event.
Type Parameters
- T extends keyof Events
Parameters
- event: T
- fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)
  - - (...args: ArgumentMap<Events>[Extract<T, keyof Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]
      
      Returns void
- Optional context: any
Returns Client
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:54

proxyFile

proxyFile(url: string): undefined | string
Proxy a file through January.

Returns
Proxied media URL
Parameters
- url: string
  
  URL to proxy
Returns undefined | string
- Defined in src/Client.ts:380

removeAllListeners

removeAllListeners(event?: keyof Events): Client
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof Events
Returns Client
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void), context?: any, once?: boolean): Client
Remove the listeners of a given event.
Type Parameters
- T extends keyof Events
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)
  - - (...args: ArgumentMap<Events>[Extract<T, keyof Events>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Client
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:63

useExistingSession

useExistingSession(session: PrivateSession): Promise<void>
Use an existing session to log into Revolt

Returns
An on-boarding function if on-boarding is required, undefined otherwise
Parameters
- session: PrivateSession
  
  Session data object
Returns Promise<void>
- Defined in src/Client.ts:329

Class Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: Partial<ClientOptions>

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

Private #reconnectTimeout

Private #session

Private #setConnectionFailureCount

Private #setReady

Readonly account

Readonly api

Readonly bots

Readonly channelUnreads

Readonly channelWebhooks

Readonly channels

configuration

Readonly connectionFailureCount

Readonly emojis

Readonly events

Readonly messages

`Optional` options: Partial<ClientOptions>

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;
};
}

autumn: {
enabled: boolean;
url: string;
}

captcha: {
enabled: boolean;
key: string;
}

january: {
enabled: boolean;
url: string;
}

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

`Private` #reconnectTimeout

`Private` #session

`Private` #setConnectionFailureCount

`Private` #setReady

`Readonly` account

`Readonly` api

`Readonly` bots

`Readonly` channelUnreads

`Readonly` channelWebhooks

`Readonly` channels

`Readonly` connectionFailureCount

`Readonly` emojis

`Readonly` events

`Readonly` messages

`Readonly` options

`Readonly` ready

`Readonly` serverMembers

`Readonly` servers

`Readonly` sessions

`Readonly` users

`Static` prefixed

`Private` #fetchConfiguration

`Private` #updateHeaders

`Rest` ...args: ArgumentMap<Events>[Extract<T, keyof Events>]

`Optional` context: any

`Rest` ...args: ArgumentMap<Events>[Extract<T, keyof Events>]

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;
}