default | revolt.js

Hierarchy

default<string, User>
- default

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new default(client: Client): default

Overrides default.constructor
- Defined in src/maps/Users.ts:226
Parameters
- client: Client
Returns default

Properties

[$mobx]

[$mobx]: {}

Type declaration

changeListeners_

changeListeners_: any

client

client: Client

data_

data_: Map<string, ObservableValue<User>>

dehancer

dehancer: any

enhancer_

enhancer_: IEnhancer<User>

hasMap_

hasMap_: Map<string, ObservableValue<boolean>>

interceptors_

interceptors_: any

keysAtom_

keysAtom_: IAtom

name_

name_: string

Accessors

[toStringTag]

get [toStringTag](): string

- Defined in node_modules/mobx/dist/types/observablemap.d.ts:68
Returns string

size

get size(): number

- Defined in node_modules/mobx/dist/types/observablemap.d.ts:65
Returns number

Methods

$get

$get(id: string, data?: { _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }): User

- Defined in src/maps/Users.ts:238
Parameters
- id: string
- Optional data: { _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }
  - _id: string
    
    description
    
    Unique Id
  - Optional avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }
    
    description
    
    Avatar attachment
  - Optional badges?: null | number
    
    Format: int32
    
    description
    
    Bitfield of user badges
  - Optional bot?: null | { owner: string }
    
    description
    
    Bot information
  - Optional flags?: null | number
    
    Format: int32
    
    description
    
    Enum of user flags
  - Optional online?: null | boolean
    
    description
    
    Whether this user is currently online
  - Optional privileged?: boolean
    
    description
    
    Whether this user is privileged
  - Optional profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }
    
    description
    
    User's profile page
  - Optional relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]
    
    description
    
    Relationships with other users
  - Optional relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"
    
    description
    
    Current session user's relationship with this user
  - Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }
    
    description
    
    User's current status
  - username: string
    
    description
    
    Username
Returns User

[iterator]

[iterator](): IterableIterator<IMapEntry<string, User>>

Inherited from default.[iterator]
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:59
Returns IterableIterator<IMapEntry<string, User>>

changeUsername

changeUsername(username: string, password: string): Promise<{ _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }>

- Defined in src/maps/Users.ts:287
Change the username of the current user

Parameters
- username: string
  
  New username
- password: string
  
  Current password
Returns Promise<{ _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }>

clear

clear(): void

Inherited from default.clear
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:63
Returns void

createObj

createObj(data: { _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }): User

- Defined in src/maps/Users.ts:262
Create a user object. This is meant for internal use only.

Parameters
- data: { _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }
  - _id: string
    
    description
    
    Unique Id
  - Optional avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }
    
    description
    
    Avatar attachment
  - Optional badges?: null | number
    
    Format: int32
    
    description
    
    Bitfield of user badges
  - Optional bot?: null | { owner: string }
    
    description
    
    Bot information
  - Optional flags?: null | number
    
    Format: int32
    
    description
    
    Enum of user flags
  - Optional online?: null | boolean
    
    description
    
    Whether this user is currently online
  - Optional privileged?: boolean
    
    description
    
    Whether this user is privileged
  - Optional profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }
    
    description
    
    User's profile page
  - Optional relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]
    
    description
    
    Relationships with other users
  - Optional relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"
    
    description
    
    Current session user's relationship with this user
  - Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }
    
    description
    
    User's current status
  - username: string
    
    description
    
    Username
Returns User

User

delete

delete(key: string): boolean

Inherited from default.delete
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:50
Parameters
- key: string
Returns boolean

edit

edit(data: { avatar?: null | string; profile?: null | { background?: null | string; content?: null | string }; remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground")[]; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string } }): Promise<void>

- Defined in src/maps/Users.ts:278
Edit the current user

Parameters
- data: { avatar?: null | string; profile?: null | { background?: null | string; content?: null | string }; remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground")[]; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string } }
  
  User edit data object
  - Optional avatar?: null | string
    
    description
    
    Attachment Id for avatar
  - Optional profile?: null | { background?: null | string; content?: null | string }
    
    description
    
    New user profile data
    
    This is applied as a partial.
  - Optional remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground")[]
    
    description
    
    Fields to remove from user object
  - Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }
    
    description
    
    New user status
Returns Promise<void>

entries

entries(): IterableIterator<IMapEntry<string, User>>

Inherited from default.entries
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:58
Returns IterableIterator<IMapEntry<string, User>>

fetch

fetch(id: string, data?: { _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }): Promise<User>

- Defined in src/maps/Users.ts:249
Fetch a user

Parameters
- id: string
  
  User ID
- Optional data: { _id: string; avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; badges?: null | number; bot?: null | { owner: string }; flags?: null | number; online?: null | boolean; privileged?: boolean; profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }; relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]; relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"; status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }; username: string }
  - _id: string
    
    description
    
    Unique Id
  - Optional avatar?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }
    
    description
    
    Avatar attachment
  - Optional badges?: null | number
    
    Format: int32
    
    description
    
    Bitfield of user badges
  - Optional bot?: null | { owner: string }
    
    description
    
    Bot information
  - Optional flags?: null | number
    
    Format: int32
    
    description
    
    Enum of user flags
  - Optional online?: null | boolean
    
    description
    
    Whether this user is currently online
  - Optional privileged?: boolean
    
    description
    
    Whether this user is privileged
  - Optional profile?: null | { background?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; content?: null | string }
    
    description
    
    User's profile page
  - Optional relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]
    
    description
    
    Relationships with other users
  - Optional relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"
    
    description
    
    Current session user's relationship with this user
  - Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }
    
    description
    
    User's current status
  - username: string
    
    description
    
    Username
Returns Promise<User>

User

forEach

forEach(callback: (value: User, key: string, object: Map<string, User>) => void, thisArg?: any): void

Inherited from default.forEach
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:60
Parameters
- callback: (value: User, key: string, object: Map<string, User>) => void
  - - (value: User, key: string, object: Map<string, User>): void
    - Parameters
      - value: User
      - key: string
      - object: Map<string, User>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: string): undefined | User

Inherited from default.get
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:54
Parameters
- key: string
Returns undefined | User

has

has(key: string): boolean

Inherited from default.has
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:48
Parameters
- key: string
Returns boolean

intercept_

intercept_(handler: IInterceptor<IMapWillChange<string, User>>): Lambda

Inherited from default.intercept_
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:75
Parameters
- handler: IInterceptor<IMapWillChange<string, User>>
Returns Lambda

keys

keys(): IterableIterator<string>

Inherited from default.keys
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:56
Returns IterableIterator<string>

merge

merge(other: any): ObservableMap<string, User>

Inherited from default.merge
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:62
Merge another object into this object, returns this.

Parameters
- other: any
Returns ObservableMap<string, User>

observe_

observe_(listener: (changes: IMapDidChange<string, User>) => void, fireImmediately?: boolean): Lambda

Inherited from default.observe_
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:74
Observes this object. Triggers for the events 'add', 'update' and 'delete'. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/observe for callback details

Parameters
- listener: (changes: IMapDidChange<string, User>) => void
  - - (changes: IMapDidChange<string, User>): void
    - Parameters
      - changes: IMapDidChange<string, User>
      Returns void
- Optional fireImmediately: boolean
Returns Lambda

replace

replace(values: any): ObservableMap<string, User>

Inherited from default.replace
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:64
Parameters
- values: any
Returns ObservableMap<string, User>

set

set(key: string, value: User): default

Inherited from default.set
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:49
Parameters
- key: string
- value: User
Returns default

toJSON

toJSON(): [string, User][]

Inherited from default.toJSON
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:67
Returns [string, User][]

toString

toString(): string

Inherited from default.toString
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:66
Returns string

values

values(): IterableIterator<User>

Inherited from default.values
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:57
Returns IterableIterator<User>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns default

Properties

[$mobx]

Type declaration

changeListeners_

client

data_

dehancer

enhancer_

hasMap_

interceptors_

keysAtom_

name_

Accessors

[toStringTag]

Returns string

size

Returns number

Methods

$get

Parameters

id: string

_id: string

Optional badges?: null | number

Optional bot?: null | { owner: string }

Optional flags?: null | number

Optional online?: null | boolean

Optional privileged?: boolean

Optional relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]

Optional relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"

Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }

username: string

Returns User

[iterator]

Returns IterableIterator<IMapEntry<string, User>>

changeUsername

Parameters

username: string

password: string

clear

Returns void

createObj

Parameters

_id: string

Optional badges?: null | number

Optional bot?: null | { owner: string }

Optional flags?: null | number

Optional online?: null | boolean

Optional privileged?: boolean

Optional relations?: null | { _id: string; status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther" }[]

Optional relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"

Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }

username: string

Returns User

delete

Parameters

key: string

Returns boolean

edit

Parameters

Optional avatar?: null | string

Optional profile?: null | { background?: null | string; content?: null | string }

Optional remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground")[]

Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string }

Returns Promise<void>

entries

Returns IterableIterator<IMapEntry<string, User>>

fetch

Parameters

id: string