Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

  • Returns string

size

  • get size(): number

  • Returns number

Methods

$get

  • $get(id: string, data?: User): User

[iterator]

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

  • Returns IterableIterator<IMapEntry<string, User>>

changeUsername

  • changeUsername(username: string, password: string): Promise<undefined>

  • Change the username of the current user

    Parameters

    • username: string

      New username

    • password: string

      Current password

    Returns Promise<undefined>

clear

  • clear(): void

  • Returns void

createObj

  • createObj(data: User): User

  • Create a user object. This is meant for internal use only.

    Parameters

    • data: User

    Returns User

    User

delete

  • delete(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

edit

  • edit(data: { avatar?: string; profile?: { background?: string; content?: string }; remove?: RemoveUserField; status?: Status }): Promise<void>

  • Edit the current user

    Parameters

    • data: { avatar?: string; profile?: { background?: string; content?: string }; remove?: RemoveUserField; status?: Status }

      User edit data object

      • Optional avatar?: string
      • Optional profile?: { background?: string; content?: string }
        • Optional background?: string
        • Optional content?: string
      • Optional remove?: RemoveUserField
      • Optional status?: Status

    Returns Promise<void>

entries

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

  • Returns IterableIterator<IMapEntry<string, User>>

fetch

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

forEach

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

  • 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

  • Parameters

    • key: string

    Returns undefined | User

has

  • has(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

intercept_

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

  • Parameters

    • handler: IInterceptor<IMapWillChange<string, User>>

    Returns Lambda

keys

  • keys(): IterableIterator<string>

  • Returns IterableIterator<string>

merge

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

  • 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

replace

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

  • Parameters

    • values: any

    Returns ObservableMap<string, User>

set

  • Parameters

    • key: string
    • value: User

    Returns default

toJSON

  • toJSON(): [string, User][]

  • Returns [string, User][]

toString

  • toString(): string

  • Returns string

values

  • values(): IterableIterator<User>

  • Returns IterableIterator<User>

Generated using TypeDoc