Class User

Entity interface.

Hierarchy (View Summary)

Entity<UserData>
- User

Constructors

constructor

new User(): User
Returns User
Overrides Entity.constructor
- Defined in packages/tilmeld-client/src/User.ts:211

Properties

`Protected`$data

$data: UserData

The data proxy object.

`Protected`$dataHandler

$dataHandler: Object

The data proxy handler.

`Protected`$dataStore

$dataStore: UserData

The actual data store.

`Protected`$dirty

$dirty: { [k: string]: boolean }

A map of props to whether they're dirty (for patch).

`Protected`$isASleepingReference

$isASleepingReference: boolean

Whether this instance is a sleeping reference.

$nymph

$nymph: Nymph

The instance of Nymph to use for queries.

`Protected`$originalTags

$originalTags: string[]

Array of the entity's original tags (for patch).

`Protected`$sleepingReference

$sleepingReference: EntityReference | null

The reference to use to wake.

`Protected`$wakePromise

$wakePromise: Promise<Entity<UserData>> | null

A promise that resolved when the entity's data is wake.

cdate

cdate: number | null

The creation date of the entity as a high precision Unix timestamp.

guid

guid: string | null

The entity's Globally Unique ID.

mdate

mdate: number | null

The modified date of the entity as a high precision Unix timestamp.

`Static`class

class: string = 'User'

The lookup name for this entity.

This is used for reference arrays (and sleeping references) and server requests.

`Static`nymph

nymph: Nymph

The instance of Nymph to use for queries.

`Protected` `Static`stores

stores: WeakMap<Nymph, InstanceStore> = ...

Methods

$addTag

$addTag(...tags: string[]): void
Add one or more tags.
Parameters
- ...tags: string[]
  List of tags.
Returns void
Inherited from Entity.$addTag
- Defined in packages/client/dist/Entity.d.ts:121

$arraySearch

$arraySearch(array: any[], strict?: boolean): number
Search the array for this object and return the corresponding index.

If strict is false, is() is used to compare. If strict is true, equals() is used.
Parameters
- array: any[]
  The array to search.
- Optionalstrict: boolean
  Whether to use stronger comparison.
Returns number
The index if the object is in the array, -1 if it isn't.
Inherited from Entity.$arraySearch
- Defined in packages/client/dist/Entity.d.ts:122

$asleep

$asleep(): boolean
Check if this is a sleeping reference.

Returns boolean
Inherited from Entity.$asleep
- Defined in packages/client/dist/Entity.d.ts:138

$changePassword

$changePassword(
    data: {
        currentPassword: string;
        newPassword: string;
        revokeCurrentTokens?: boolean;
    },
): Promise<{ message: string; result: boolean }>
Parameters
- data: { currentPassword: string; newPassword: string; revokeCurrentTokens?: boolean }
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:316

`Protected`$check

$check(): void
Check if this is a sleeping reference and throw an error if so.

Returns void
Inherited from Entity.$check
- Defined in packages/client/dist/Entity.d.ts:134

$checkEmail

$checkEmail(): Promise<{ message: string; result: boolean }>
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:227

$checkPhone

$checkPhone(): Promise<{ message: string; result: boolean }>
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:234

$checkUsername

$checkUsername(): Promise<{ message: string; result: boolean }>
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:220

$delete

$delete(): Promise<boolean>
Delete the object from storage.

Returns Promise<boolean>
True on success, false on failure.
Inherited from Entity.$delete
- Defined in packages/client/dist/Entity.d.ts:123

$equals

$equals(object: any): boolean
Perform a more strict comparison of this object to another.
Parameters
- object: any
  The object to compare.
Returns boolean
True or false.
Inherited from Entity.$equals
- Defined in packages/client/dist/Entity.d.ts:124

$gatekeeper

$gatekeeper(ability?: string): Promise<boolean>
Parameters
- Optionalability: string
Returns Promise<boolean>
- Defined in packages/tilmeld-client/src/User.ts:312

$getAvatar

$getAvatar(): Promise<string>
Returns Promise<string>
- Defined in packages/tilmeld-client/src/User.ts:241

$getNewTOTPSecret

$getNewTOTPSecret(): Promise<{ qrcode: string; secret: string; uri: string }>
Returns Promise<{ qrcode: string; secret: string; uri: string }>
- Defined in packages/tilmeld-client/src/User.ts:334

$getPatch

$getPatch(): EntityPatch
Get a patch of this entity's dirty data to be applied on the server.

Returns EntityPatch
Inherited from Entity.$getPatch
- Defined in packages/client/dist/Entity.d.ts:125

$hasTag

$hasTag(...tags: string[]): boolean
Check that the entity has all of the given tags.
Parameters
- ...tags: string[]
  List of tags.
Returns boolean
True or false.
Inherited from Entity.$hasTag
- Defined in packages/client/dist/Entity.d.ts:126

$hasTOTPSecret

$hasTOTPSecret(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/tilmeld-client/src/User.ts:330

$inArray

$inArray(array: any[], strict?: boolean): boolean
Check whether this object is in an array.

If strict is false, is() is used to compare. If strict is true, equals() is used.
Parameters
- array: any[]
  The array to search.
- Optionalstrict: boolean
  Whether to use stronger comparison.
Returns boolean
True if the object is in the array, false if it isn't.
Inherited from Entity.$inArray
- Defined in packages/client/dist/Entity.d.ts:128

$init

$init(entityJson: EntityJson | null): Entity<UserData>
Initialize this entity from a JSON representation.
Parameters
- entityJson: EntityJson | null
  The entity JSON.
Returns Entity<UserData>
Inherited from Entity.$init
- Defined in packages/client/dist/Entity.d.ts:120

$is

$is(object: any): boolean
Perform a less strict comparison of this object to another.
Parameters
- object: any
  The object to compare.
Returns boolean
True or false.
Inherited from Entity.$is
- Defined in packages/client/dist/Entity.d.ts:129

$isDirty

$isDirty(property: string): boolean | null
Check whether a property is dirty.

To be a dirty property, it must have been set or deleted since the entity was initialized. A clean property existed on initialization and hasn't been set or deleted. An untracked property didn't exist on initialization and hasn't been set or deleted.

Note that this doesn't necessarily mean the property has changed. It could have been set to the same value, or created and then deleted.

Entities are initialized when they are pulled from the server or saved. This is done with the $init method.
Parameters
- property: string
  The name of a property.
Returns boolean | null
True if it's dirty, false if not, and null if it's not tracked.
Inherited from Entity.$isDirty
- Defined in packages/client/dist/Entity.d.ts:127

$logout

$logout(): Promise<{ message: string; result: boolean }>
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:294

$patch

$patch(): Promise<boolean>
Save the object's dirty data to storage.

Returns Promise<boolean>
True on success, false on failure.
Inherited from Entity.$patch
- Defined in packages/client/dist/Entity.d.ts:130

`Protected`$referenceSleep

$referenceSleep(reference: EntityReference): void
Parameters
- reference: EntityReference
Returns void
Inherited from Entity.$referenceSleep
- Defined in packages/client/dist/Entity.d.ts:144

$refresh

$refresh(): Promise<boolean | 0>
Refresh the object from storage. (Bypasses Nymph's cache.)

If the object has been deleted from storage, the database cannot be reached, or a database error occurs, refresh() will return 0.

Returns Promise<boolean | 0>
False if the data has not been saved, 0 if it can't be refreshed, true on success.
Inherited from Entity.$refresh
- Defined in packages/client/dist/Entity.d.ts:145

$register

$register(
data: { additionalData?: { [k: string]: any }; password: string },
): Promise<{ loggedin: boolean; message: string; result: boolean }>
Parameters
- data: { additionalData?: { [k: string]: any }; password: string }
Returns Promise<{ loggedin: boolean; message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:245

$removeTag

$removeTag(...tags: string[]): void
Remove one or more tags.
Parameters
- ...tags: string[]
  List of tags.
Returns void
Inherited from Entity.$removeTag
- Defined in packages/client/dist/Entity.d.ts:146

$removeTOTPSecret

$removeTOTPSecret(
data?: { code: string; password: string },
): Promise<{ message: string; result: boolean }>
Parameters
- Optionaldata: { code: string; password: string }
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:350

$revokeCurrentTokens

$revokeCurrentTokens(
data: { password: string },
): Promise<{ message: string; result: boolean }>
Parameters
- data: { password: string }
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:324

$save

$save(): Promise<boolean>
Save the object to storage.

Returns Promise<boolean>
True on success, false on failure.
Inherited from Entity.$save
- Defined in packages/client/dist/Entity.d.ts:147

$saveTOTPSecret

$saveTOTPSecret(
data: { code: string; password: string; secret: string },
): Promise<{ message: string; result: boolean }>
Parameters
- data: { code: string; password: string; secret: string }
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:342

$serverCall

$serverCall(
    method: string,
    params: Iterable<any>,
    stateless?: boolean,
): Promise<any>
Call an instance method on the server version of this entity.

The entity's data will be sent up to the server as well, so the server's state can match the client's state. It won't be propagated into the DB, though.
Parameters
- method: string
  The name of the method.
- params: Iterable<any>
  The parameters to call the method with.
- Optionalstateless: boolean
  Whether the server should return, and the client update, the data in the entity after the method has run.
Returns Promise<any>
The value that the method on the server returned.
Inherited from Entity.$serverCall
- Defined in packages/client/dist/Entity.d.ts:148

$switchUser

$switchUser(
data?: { additionalData?: { [k: string]: any } },
): Promise<{ message: string; result: boolean }>
Parameters
- Optionaldata: { additionalData?: { [k: string]: any } }
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:271

$toReference

$toReference(): EntityReference | EntityInterface
Return a Nymph Entity Reference for this entity.

If the entity hasn't been saved yet (and has no GUID), it will be returned instead.

Returns EntityReference | EntityInterface
A Nymph Entity Reference array as an unsaved entity.
Inherited from Entity.$toReference
- Defined in packages/client/dist/Entity.d.ts:149

$wake

$wake(): Promise<Entity<UserData>>
Wake from a sleeping reference.

Returns Promise<Entity<UserData>>
Inherited from Entity.$wake
- Defined in packages/client/dist/Entity.d.ts:142

$wakeAll

$wakeAll(level?: number): Promise<Entity<UserData>>
Ready this entity's data, and the data of entity's within this one's.
Parameters
- Optionallevel: number
  The number of levels deep to wake. If undefined, it will keep going until there are no more entities. (Careful of infinite loops.)
Returns Promise<Entity<UserData>>
The entity.
Inherited from Entity.$wakeAll
- Defined in packages/client/dist/Entity.d.ts:143

toJSON

toJSON(): EntityJson
Returns EntityJson
Inherited from Entity.toJSON
- Defined in packages/client/dist/Entity.d.ts:119

`Static`current

current(
    returnObjectIfNotExist: true,
): Promise<
    User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: | (
                User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
            )
            | null;
        };
        groups?: (
            Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: | (
                    User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                )
                | null;
            }
        )[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    },
>
Parameters
- returnObjectIfNotExist: true
Returns Promise<
    User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: | (
                User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
            )
            | null;
        };
        groups?: (
            Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: | (
                    User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                )
                | null;
            }
        )[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    },
>
- Defined in packages/tilmeld-client/src/User.ts:359
current(
    returnObjectIfNotExist?: false,
): Promise<
    | User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: | (
                User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
            )
            | null;
        };
        groups?: (
            Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: | (
                    User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                )
                | null;
            }
        )[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    }
    | null,
>
Parameters
- OptionalreturnObjectIfNotExist: false
Returns Promise<
    | User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: | (
                User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
            )
            | null;
        };
        groups?: (
            Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: | (
                    User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                )
                | null;
            }
        )[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    }
    | null,
>
- Defined in packages/tilmeld-client/src/User.ts:362

`Static`factory

factory<E extends Entity<EntityData>>(
this: new () => E,
guid?: string,
): Promise<E & EntityDataType<E>>
Create or retrieve a new entity instance.

Note that this will always return an entity, even if the GUID is not found.
Type Parameters
- E extends Entity<EntityData>
Parameters
- this: new () => E
- Optionalguid: string
  An optional GUID to retrieve.
Returns Promise<E & EntityDataType<E>>
Inherited from Entity.factory
- Defined in packages/client/dist/Entity.d.ts:82

`Static`factoryReference

factoryReference<E extends Entity<EntityData>>(
this: new () => E,
reference: EntityReference,
): E & EntityDataType<E>
Create a new sleeping reference instance.

Sleeping references won't retrieve their data from the server until they are readied with $wake() or a parent's $wakeAll().
Type Parameters
- E extends Entity<EntityData>
Parameters
- this: new () => E
- reference: EntityReference
  The Nymph Entity Reference to use to wake.
Returns E & EntityDataType<E>
The new instance.
Inherited from Entity.factoryReference
- Defined in packages/client/dist/Entity.d.ts:100

`Static`factorySync

factorySync<E extends Entity<EntityData>>(
this: new () => E,
): E & EntityDataType<E>
Create a new entity instance.
Type Parameters
- E extends Entity<EntityData>
Parameters
- this: new () => E
Returns E & EntityDataType<E>
Inherited from Entity.factorySync
- Defined in packages/client/dist/Entity.d.ts:88

`Static`factoryUsername

factoryUsername(username?: string): Promise<User & UserData>
Parameters
- Optionalusername: string
Returns Promise<User & UserData>
- Defined in packages/tilmeld-client/src/User.ts:180

`Static`getClientConfig

getClientConfig(): Promise<ClientConfig>
Returns Promise<ClientConfig>
- Defined in packages/tilmeld-client/src/User.ts:418

`Static`getDomainUsers

getDomainUsers(
    domain: string,
    options?: {
        limit?: number;
        offset?: number;
        reverse?: boolean;
        sort?: string;
    },
): Promise<(User & UserData)[]>
Parameters
- domain: string
- Optionaloptions: { limit?: number; offset?: number; reverse?: boolean; sort?: string }
Returns Promise<(User & UserData)[]>
- Defined in packages/tilmeld-client/src/User.ts:199

`Static`init

init(nymph: Nymph): void
Parameters
- nymph: Nymph
Returns void
- Defined in packages/tilmeld-client/src/User.ts:154

`Static`loginUser

loginUser(
    data: {
        additionalData?: { [k: string]: any };
        code?: string;
        password: string;
        username: string;
    },
): Promise<
    {
        message: string;
        needTOTP?: true;
        result: boolean;
        user?: User & UserData & {
            abilities?: string[];
            email?: string;
            group?: Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: | (
                    User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                )
                | null;
            };
            groups?: (
                Group & GroupData & {
                    abilities?: (...)[];
                    email?: string;
                    phone?: string;
                    user?:
                        | (
                            User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                        )
                        | null;
                }
            )[];
            inheritAbilities?: boolean;
            newEmailAddress?: string;
            phone?: string;
        };
    },
>
Parameters
- data: {
      additionalData?: { [k: string]: any };
      code?: string;
      password: string;
      username: string;
  }
Returns Promise<
    {
        message: string;
        needTOTP?: true;
        result: boolean;
        user?: User & UserData & {
            abilities?: string[];
            email?: string;
            group?: Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: | (
                    User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                )
                | null;
            };
            groups?: (
                Group & GroupData & {
                    abilities?: (...)[];
                    email?: string;
                    phone?: string;
                    user?:
                        | (
                            User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...
                        )
                        | null;
                }
            )[];
            inheritAbilities?: boolean;
            newEmailAddress?: string;
            phone?: string;
        };
    },
>
- Defined in packages/tilmeld-client/src/User.ts:375

`Static`off

off<T extends EventType>(
    event: T,
    callback: T extends "register"
        ? RegisterCallback
        : T extends "login"
            ? LoginCallback
            : T extends "logout" ? LogoutCallback : never,
): boolean
Type Parameters
- T extends EventType
Parameters
- event: T
- callback: T extends "register"
      ? RegisterCallback
      : T extends "login"
          ? LoginCallback
          : T extends "logout" ? LogoutCallback : never
Returns boolean
- Defined in packages/tilmeld-client/src/User.ts:538

`Static`on

on<T extends EventType>(
    event: T,
    callback: T extends "register"
        ? RegisterCallback
        : T extends "login"
            ? LoginCallback
            : T extends "logout" ? LogoutCallback : never,
): () => boolean
Type Parameters
- T extends EventType
Parameters
- event: T
- callback: T extends "register"
      ? RegisterCallback
      : T extends "login"
          ? LoginCallback
          : T extends "logout" ? LogoutCallback : never
Returns () => boolean
- Defined in packages/tilmeld-client/src/User.ts:506

`Static`recover

recover(
data: { password: string; secret: string; username: string },
): Promise<{ message: string; result: boolean }>
Parameters
- data: { password: string; secret: string; username: string }
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:410

`Static`sendRecovery

sendRecovery(
data: { account: string; recoveryType: "username" | "password" },
): Promise<{ message: string; result: boolean }>
Parameters
- data: { account: string; recoveryType: "username" | "password" }
Returns Promise<{ message: string; result: boolean }>
- Defined in packages/tilmeld-client/src/User.ts:403

`Static`serverCallStatic

serverCallStatic(method: string, params: Iterable<any>): Promise<any>
Call a static method on the server version of this entity.
Parameters
- method: string
  The name of the method.
- params: Iterable<any>
  The parameters to call the method with.
Returns Promise<any>
The value that the method on the server returned.
Inherited from Entity.serverCallStatic
- Defined in packages/client/dist/Entity.d.ts:110

`Static`serverCallStaticIterator

serverCallStaticIterator(
method: string,
params: Iterable<any>,
): Promise<AbortableAsyncIterator<any>>
Call a static iterator method on the server version of this entity.
Parameters
- method: string
  The name of the method.
- params: Iterable<any>
  The parameters to call the method with.
Returns Promise<AbortableAsyncIterator<any>>
An iterator that iterates over values that the method on the server yields.
Inherited from Entity.serverCallStaticIterator
- Defined in packages/client/dist/Entity.d.ts:118

Class User

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns User

Properties

Protected$data

Protected$dataHandler

Protected$dataStore

Protected$dirty

Protected$isASleepingReference

$nymph

Protected$originalTags

Protected$sleepingReference

Protected$wakePromise

cdate

guid

mdate

tags

Staticclass

Staticnymph

Protected Staticstores

Methods

$addTag

Parameters

Returns void

$arraySearch

Parameters

Returns number

$asleep

Returns boolean

$changePassword

Parameters

Returns Promise<{ message: string; result: boolean }>

Protected$check

Returns void

$checkEmail

Returns Promise<{ message: string; result: boolean }>

$checkPhone

Returns Promise<{ message: string; result: boolean }>

$checkUsername

Returns Promise<{ message: string; result: boolean }>

$delete

Returns Promise<boolean>

$equals

Parameters

Returns boolean

$gatekeeper

Parameters

Returns Promise<boolean>

$getAvatar

Returns Promise<string>

$getNewTOTPSecret

Returns Promise<{ qrcode: string; secret: string; uri: string }>

$getPatch

Returns EntityPatch

$hasTag

Parameters

Returns boolean

$hasTOTPSecret

Returns Promise<boolean>

$inArray

Parameters

Returns boolean

$init

Parameters

Returns Entity<UserData>

$is

Parameters

Returns boolean

$isDirty

Parameters

Returns boolean | null

$logout

Returns Promise<{ message: string; result: boolean }>

$patch

`Protected`$data

`Protected`$dataHandler

`Protected`$dataStore

`Protected`$dirty

`Protected`$isASleepingReference

`Protected`$originalTags

`Protected`$sleepingReference

`Protected`$wakePromise

`Static`class

`Static`nymph

`Protected` `Static`stores

`Protected`$check

`Protected`$referenceSleep

`Static`current

`Static`factory

`Static`factoryReference

`Static`factorySync

`Static`factoryUsername

`Static`getClientConfig

`Static`getDomainUsers

`Static`init

`Static`loginUser

`Static`off