CosmosClient | @cosmos-xyz/cosmos

Hierarchy

EventEmitter
- CosmosClient

Index

Constructors

constructor

Properties

Accessors

ownerID

Methods

Constructors

constructor

new CosmosClient(options?: Partial<CosmosOptions>): CosmosClient

- Defined in src/structs/Client.ts:186
Parameters
- options: Partial<CosmosOptions> = {}
Returns CosmosClient

Properties

Readonly bot

bot: Client

The revolt.js Client object

connected

connected: boolean

If the bot is connected to the websocket

Optional loginDetail

loginDetail?: ConnectDetails

Details for logging in

Readonly options

options: Partial<CosmosOptions>

The client options given when initiating the client

Readonly perms

perms: Permissions

Permission checking

uptime

uptime: number

Number (in milliseconds) since the bot is ready

Readonly utils

utils: CosmosUtils

Utility functions

Static prefixed

prefixed: string | boolean

Accessors

ownerID

get ownerID(): undefined | string

- Defined in src/structs/Client.ts:311
Returns ID of the client owner, if any.

Returns undefined | string

Methods

addListener

addListener<T>(event: T, fn: (...args: any[]) => void, context?: any): CosmosClient

- Defined in node_modules/eventemitter3/index.d.ts:45
Type parameters
- T: string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
Returns CosmosClient

emit

emit<T>(event: T, ...args: any[]): boolean

- Defined in node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.

Type parameters
- T: string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.

Parameters
- event: string | symbol
Returns number

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]

- Defined in node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.

Type parameters
- T: string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]

login

- Defined in src/structs/Client.ts:320
Login to Revolt

Parameters
- Optional detail: ConnectDetails
  
  Login details, can also be defined when initiating the client
Returns Promise<void | ((username: string, loginAfterSuccess?: boolean) => Promise<void>)>
An onboarding function if required, else undefined or void

logout

logout(): Promise<void>

- Defined in src/structs/Client.ts:344
Logout from Revolt

Returns Promise<void>
void

off

off<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): CosmosClient

- Defined in node_modules/eventemitter3/index.d.ts:69
Type parameters
- T: string | symbol
Parameters
- event: T
- Optional fn: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns CosmosClient

on

on(event: "connected", listener: () => void): CosmosClient
on(event: "connecting", listener: () => void): CosmosClient
on(event: "disconnected", listener: () => void): CosmosClient
on(event: "ready", listener: (users: User[], servers: Server[], channels: Channel[], members: Member[]) => void): CosmosClient
on(event: "logout", listener: () => void): CosmosClient
on(event: "raw", listener: (payload: ClientboundNotification) => void): CosmosClient
on(event: "message", listener: (message: Message) => void): CosmosClient
on(event: "messageUpdate", listener: (message: Message, details: MessageUpdatedDetails) => void): CosmosClient
on(event: "messageDelete", listener: (_id: string) => void): CosmosClient
on(event: "channelCreate", listener: (channel: Channel) => void): CosmosClient
on(event: "channelUpdate", listener: (channel: Channel, details: ChannelUpdatedDetails) => void): CosmosClient
on(event: "channelDelete", listener: (_id: string) => void): CosmosClient
on(event: "groupJoin", listener: (_id: string, user: string) => void): CosmosClient
on(event: "groupLeave", listener: (_id: string, user: string) => void): CosmosClient
on(event: "typingStart", listener: (_id: string, user: string) => void): CosmosClient
on(event: "typingStop", listener: (_id: string, user: string) => void): CosmosClient
on(event: "channelAck", listener: (_id: string, user: string, message: string) => void): CosmosClient
on(event: "serverUpdate", listener: (server: Server, details: ServerUpdatedDetails) => void): CosmosClient
on(event: "serverDelete", listener: (_id: string) => void): CosmosClient
on(event: "memberJoin", listener: (member: Member) => void): CosmosClient
on(event: "memberUpdate", listener: (member: Member, details: MemberUpdatedDetails) => void): CosmosClient
on(event: "memberLeave", listener: (_id: MemberCompositeKey) => void): CosmosClient
on(event: "roleUpdate", listener: (role: Role, details: RoleUpdatedDetails) => void): CosmosClient
on(event: "roleDelete", listener: (_id: string, server: string) => void): CosmosClient
on(event: "userUpdate", listener: (user: User, details: UserUpdatedDetails) => void): CosmosClient
on(event: "relationshipUpdate", listener: (_id: string, user: string, relationship: RelationshipStatus) => void): CosmosClient
on(event: string, listener: (...args: any[]) => void): CosmosClient

- Defined in src/structs/Client.ts:22
Emitted when the server authenticated the connection

Parameters
- event: "connected"
- listener: () => void
  - - (): void
    - Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:24
Emitted when the client is connecting to the server

Parameters
- event: "connecting"
- listener: () => void
  - - (): void
    - Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:26
Emitted when the connection dropped

Parameters
- event: "disconnected"
- listener: () => void
  - - (): void
    - Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:35
Emitted when the client is ready

Parameters
- event: "ready"
- listener: (users: User[], servers: Server[], channels: Channel[], members: Member[]) => void
  - - (users: User[], servers: Server[], channels: Channel[], members: Member[]): void
    - Parameters
      - users: User[]
      - servers: Server[]
      - channels: Channel[]
      - members: Member[]
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:38
Emitted when the client logged out

Parameters
- event: "logout"
- listener: () => void
  - - (): void
    - Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:44
Emitted when the websocket receives any data

Parameters
- event: "raw"
- listener: (payload: ClientboundNotification) => void
  - - (payload: ClientboundNotification): void
    - Parameters
      - payload: ClientboundNotification
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:50
Emitted when a message is sent

Parameters
- event: "message"
- listener: (message: Message) => void
  - - (message: Message): void
    - Parameters
      - message: Message
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:55
Emitted when a message is edited

Parameters
- event: "messageUpdate"
- listener: (message: Message, details: MessageUpdatedDetails) => void
  - - (message: Message, details: MessageUpdatedDetails): void
    - Parameters
      - message: Message
      - details: MessageUpdatedDetails
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:60
Emitted when a message is deleted

Parameters
- event: "messageDelete"
- listener: (_id: string) => void
  - - (_id: string): void
    - Parameters
      - _id: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:66
Emitted when a new channel is created

Parameters
- event: "channelCreate"
- listener: (channel: Channel) => void
  - - (channel: Channel): void
    - Parameters
      - channel: Channel
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:71
Emitted when a channel is editedhas updated changes

Parameters
- event: "channelUpdate"
- listener: (channel: Channel, details: ChannelUpdatedDetails) => void
  - - (channel: Channel, details: ChannelUpdatedDetails): void
    - Parameters
      - channel: Channel
      - details: ChannelUpdatedDetails
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:76
Emitted when a channel is deleted

Parameters
- event: "channelDelete"
- listener: (_id: string) => void
  - - (_id: string): void
    - Parameters
      - _id: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:83
Emitted when a user joined a group

Parameters
- event: "groupJoin"
- listener: (_id: string, user: string) => void
  - - (_id: string, user: string): void
    - Parameters
      - _id: string
      - user: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:89
Emitted when a group member left a group

Parameters
- event: "groupLeave"
- listener: (_id: string, user: string) => void
  - - (_id: string, user: string): void
    - Parameters
      - _id: string
      - user: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:96
Emitted when a user started typing in a channel

Parameters
- event: "typingStart"
- listener: (_id: string, user: string) => void
  - - (_id: string, user: string): void
    - Parameters
      - _id: string
      - user: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:102
Emitted when a user stopped typing in a channel

Parameters
- event: "typingStop"
- listener: (_id: string, user: string) => void
  - - (_id: string, user: string): void
    - Parameters
      - _id: string
      - user: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:109
Emitted when the client acknowledged new messages in a channel up to @param message message ID

Parameters
- event: "channelAck"
- listener: (_id: string, user: string, message: string) => void
  - - (_id: string, user: string, message: string): void
    - Parameters
      - _id: string
      - user: string
      - message: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:115
Emitted when a server has updated details

Parameters
- event: "serverUpdate"
- listener: (server: Server, details: ServerUpdatedDetails) => void
  - - (server: Server, details: ServerUpdatedDetails): void
    - Parameters
      - server: Server
      - details: ServerUpdatedDetails
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:120
Emitted when a server has been deleted

Parameters
- event: "serverDelete"
- listener: (_id: string) => void
  - - (_id: string): void
    - Parameters
      - _id: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:126
Emitted when a member joined a server

Parameters
- event: "memberJoin"
- listener: (member: Member) => void
  - - (member: Member): void
    - Parameters
      - member: Member
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:131
Emitted when a member has updated changes

Parameters
- event: "memberUpdate"
- listener: (member: Member, details: MemberUpdatedDetails) => void
  - - (member: Member, details: MemberUpdatedDetails): void
    - Parameters
      - member: Member
      - details: MemberUpdatedDetails
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:136
Emitted when a member left a server

Parameters
- event: "memberLeave"
- listener: (_id: MemberCompositeKey) => void
  - - (_id: MemberCompositeKey): void
    - Parameters
      - _id: MemberCompositeKey
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:142
Emitted when a role is created or updated

Parameters
- event: "roleUpdate"
- listener: (role: Role, details: RoleUpdatedDetails) => void
  - - (role: Role, details: RoleUpdatedDetails): void
    - Parameters
      - role: Role
      - details: RoleUpdatedDetails
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:148
Emitted when a role is deleted

Parameters
- event: "roleDelete"
- listener: (_id: string, server: string) => void
  - - (_id: string, server: string): void
    - Parameters
      - _id: string
      - server: string
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:154
Emitted when a user has updated changes

Parameters
- event: "userUpdate"
- listener: (user: User, details: UserUpdatedDetails) => void
  - - (user: User, details: UserUpdatedDetails): void
    - Parameters
      - user: User
      - details: UserUpdatedDetails
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:160
Emitted when the client updated their relationship with a user

Parameters
- event: "relationshipUpdate"
- listener: (_id: string, user: string, relationship: RelationshipStatus) => void
  - - (_id: string, user: string, relationship: RelationshipStatus): void
    - Parameters
      - _id: string
      - user: string
      - relationship: RelationshipStatus
      Returns void
Returns CosmosClient
- Defined in src/structs/Client.ts:166
Custom events (if you want to add some)

Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns CosmosClient

once

once<T>(event: T, fn: (...args: any[]) => void, context?: any): CosmosClient

- Defined in node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.

Type parameters
- T: string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
Returns CosmosClient

removeAllListeners

removeAllListeners(event?: string | symbol): CosmosClient

- Defined in node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.

Parameters
- Optional event: string | symbol
Returns CosmosClient

removeListener

removeListener<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): CosmosClient

- Defined in node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.

Type parameters
- T: string | symbol
Parameters
- event: T
- Optional fn: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns CosmosClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<CosmosOptions> = {}

Returns CosmosClient

Properties

Readonly bot

connected

Optional loginDetail

Readonly options

Readonly perms

uptime

Readonly utils

Static prefixed

Accessors

ownerID

Returns undefined | string

Methods

addListener

Type parameters

T: string | symbol

Parameters

event: T

fn: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns CosmosClient

emit

Type parameters

T: string | symbol

Parameters

event: T

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Type parameters

T: string | symbol

Parameters

event: T

Returns ((...args: any[]) => void)[]

login

Parameters

Optional detail: ConnectDetails

Returns Promise<void | ((username: string, loginAfterSuccess?: boolean) => Promise<void>)>

logout

Returns Promise<void>

off

Type parameters

T: string | symbol

Parameters

event: T

Optional fn: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Optional once: boolean

Returns CosmosClient

on

Parameters

event: "connected"

listener: () => void

Returns void

Returns CosmosClient

Parameters

event: "connecting"