Class default

Hierarchy

default<string, Channel>
- default

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new default(client: Client): default

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

Properties

[$mobx]

[$mobx]: {}

Type declaration

changeListeners_

changeListeners_: any

client

client: Client

data_

data_: Map<string, ObservableValue<Channel>>

dehancer

dehancer: any

enhancer_

enhancer_: IEnhancer<Channel>

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?: Channel): Channel

- Defined in src/maps/Channels.ts:715
Parameters
- id: string
- Optional data: Channel
Returns Channel

[iterator]

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

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

clear

clear(): void

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

createGroup

createGroup(data: { description?: string; name: string; nonce: string; users: string[] }): Promise<Channel>

- Defined in src/maps/Channels.ts:758
Create a group

Parameters
- data: { description?: string; name: string; nonce: string; users: string[] }
  
  Group create route data
  - Optional description?: string
  - name: string
  - nonce: string
  - users: string[]
Returns Promise<Channel>

The newly-created group

createObj

createObj(data: Channel, emit?: number | boolean): Channel

- Defined in src/maps/Channels.ts:741
Create a channel object. This is meant for internal use only.

Parameters
- data: Channel
- Optional emit: number | boolean
  
  Whether to emit creation event
Returns Channel

Channel

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

entries

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

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

fetch

fetch(id: string, data?: Channel): Promise<Channel>

- Defined in src/maps/Channels.ts:726
Fetch a channel

Parameters
- id: string
  
  Channel ID
- Optional data: Channel
Returns Promise<Channel>

The channel

forEach

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

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

get

get(key: string): undefined | Channel

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

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, Channel>>): Lambda

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

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

observe_

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

replace

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

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

set

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

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

toJSON

toJSON(): [string, Channel][]

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

toString

toString(): string

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

values

values(): IterableIterator<Channel>

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

Generated using TypeDoc