default | revolt.js

Hierarchy

default<string, Member>
- default

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new default(client: Client): default

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

Properties

[$mobx]

[$mobx]: {}

Type declaration

changeListeners_

changeListeners_: any

client

client: Client

data_

data_: Map<string, ObservableValue<Member>>

dehancer

dehancer: any

enhancer_

enhancer_: IEnhancer<Member>

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: { server: string; user: string }, data?: { _id: { server: string; user: 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 }; joined_at: string; nickname?: null | string; roles?: string[]; timeout?: null | string }): Member

- Defined in src/maps/Members.ts:317
Parameters
- id: { server: string; user: string }
  - server: string
    
    description
    
    Server Id
  - user: string
    
    description
    
    User Id
- Optional data: { _id: { server: string; user: 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 }; joined_at: string; nickname?: null | string; roles?: string[]; timeout?: null | string }
  - _id: { server: string; user: string }
    
    description
    
    Unique member id
    - server: string
      
      description
      
      Server Id
    - user: string
      
      description
      
      User 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
  - joined_at: string
    
    description
    
    Time at which this user joined the server
  - Optional nickname?: null | string
    
    description
    
    Member's nickname
  - Optional roles?: string[]
    
    description
    
    Member's roles
  - Optional timeout?: null | string
    
    description
    
    Timestamp this member is timed out until
Returns Member

[iterator]

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

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

clear

clear(): void

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

createObj

createObj(data: { _id: { server: string; user: 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 }; joined_at: string; nickname?: null | string; roles?: string[]; timeout?: null | string }, emit?: number | boolean): Member

- Defined in src/maps/Members.ts:330
Create a member object. This is meant for internal use only.

Parameters
- data: { _id: { server: string; user: 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 }; joined_at: string; nickname?: null | string; roles?: string[]; timeout?: null | string }
  - _id: { server: string; user: string }
    
    description
    
    Unique member id
    - server: string
      
      description
      
      Server Id
    - user: string
      
      description
      
      User 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
  - joined_at: string
    
    description
    
    Time at which this user joined the server
  - Optional nickname?: null | string
    
    description
    
    Member's nickname
  - Optional roles?: string[]
    
    description
    
    Member's roles
  - Optional timeout?: null | string
    
    description
    
    Timestamp this member is timed out until
- Optional emit: number | boolean
  
  Whether to emit creation event
Returns Member

Member

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

deleteKey

deleteKey(id: { server: string; user: string }): boolean

- Defined in src/maps/Members.ts:313
Parameters
- id: { server: string; user: string }
  - server: string
    
    description
    
    Server Id
  - user: string
    
    description
    
    User Id
Returns boolean

entries

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

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

forEach

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

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

get

get(key: string): undefined | Member

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

getKey

getKey(id: { server: string; user: string }): undefined | Member

- Defined in src/maps/Members.ts:305
Parameters
- id: { server: string; user: string }
  - server: string
    
    description
    
    Server Id
  - user: string
    
    description
    
    User Id
Returns undefined | Member

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

hasKey

hasKey(id: { server: string; user: string }): boolean

- Defined in src/maps/Members.ts:301
Parameters
- id: { server: string; user: string }
  - server: string
    
    description
    
    Server Id
  - user: string
    
    description
    
    User Id
Returns boolean

intercept_

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

Inherited from default.intercept_
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:75
Parameters
- handler: IInterceptor<IMapWillChange<string, Member>>
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, Member>

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, Member>

observe_

observe_(listener: (changes: IMapDidChange<string, Member>) => 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, Member>) => void
  - - (changes: IMapDidChange<string, Member>): void
    - Parameters
      - changes: IMapDidChange<string, Member>
      Returns void
- Optional fireImmediately: boolean
Returns Lambda

replace

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

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

set

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

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

setKey

setKey(id: { server: string; user: string }, member: Member): default

- Defined in src/maps/Members.ts:309
Parameters
- id: { server: string; user: string }
  - server: string
    
    description
    
    Server Id
  - user: string
    
    description
    
    User Id
- member: Member
Returns default

toJSON

toJSON(): [string, Member][]

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

toString

toString(): string

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

values

values(): IterableIterator<Member>

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

Static toKey

toKey(id: { server: string; user: string }): string

- Defined in src/maps/Members.ts:297
Parameters
- id: { server: string; user: string }
  - server: string
    
    description
    
    Server Id
  - user: string
    
    description
    
    User Id
Returns string

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: { server: string; user: string }

server: string

user: string

_id: { server: string; user: string }

server: string

user: string

joined_at: string

Optional nickname?: null | string

Optional roles?: string[]

Optional timeout?: null | string

Returns Member

[iterator]

Returns IterableIterator<IMapEntry<string, Member>>

clear

Returns void

createObj

Parameters

_id: { server: string; user: string }

server: string

user: string

joined_at: string

Optional nickname?: null | string

Optional roles?: string[]

Optional timeout?: null | string

Optional emit: number | boolean

Returns Member

delete

Parameters

key: string

Returns boolean

deleteKey

Parameters

id: { server: string; user: string }

server: string

user: string

Returns boolean

entries

Returns IterableIterator<IMapEntry<string, Member>>

forEach

Parameters

callback: (value: Member, key: string, object: Map<string, Member>) => void

Parameters

value: Member

key: string

object: Map<string, Member>

Returns void

Optional thisArg: any

Returns void

get