Class User

Entity interface.

Hierarchy (view full)

Constructors

constructor

Properties

$data $dataHandler $dataStore $dirty $isASleepingReference $nymph $originalTags $sleepingReference $wakePromise cdate guid mdate tags class nymph stores

Methods

$addTag $arraySearch $asleep $changePassword $check $checkEmail $checkPhone $checkUsername $delete $equals $gatekeeper $getAvatar $getNewTOTPSecret $getPatch $hasTOTPSecret $hasTag $inArray $init $is $logout $patch $referenceSleep $refresh $register $removeTOTPSecret $removeTag $revokeCurrentTokens $save $saveTOTPSecret $serverCall $switchUser $toReference $wake $wakeAll toJSON current factory factoryReference factorySync factoryUsername getClientConfig handleToken init loginUser off on recover sendRecovery serverCallStatic serverCallStaticIterator

Constructors

constructor

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).

Type declaration

  • [k: string]: boolean

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: null | EntityReference

The reference to use to wake.

Protected $wakePromise

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

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

cdate

cdate: null | number

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

guid

guid: null | string

The entity's Globally Unique ID.

mdate

mdate: null | number

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

tags

tags: string[]

Array of the entity's tags.

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): void

  • Add one or more tags.

    Parameters

    • Rest ...tags: string[]

      List of tags.

    Returns void

$arraySearch

  • $arraySearch(array, strict?): 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.

    • Optional strict: boolean

      Whether to use stronger comparison.

    Returns number

    The index if the object is in the array, -1 if it isn't.

$asleep

  • $asleep(): boolean

  • Check if this is a sleeping reference.

    Returns boolean

$changePassword

  • $changePassword(data): Promise<{
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          currentPassword: string;
          newPassword: string;
          revokeCurrentTokens?: boolean;
      }
      • currentPassword: string
      • newPassword: string
      • Optional revokeCurrentTokens?: boolean

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

Protected $check

  • $check(): void

  • Check if this is a sleeping reference and throw an error if so.

    Returns void

$checkEmail

  • $checkEmail(): Promise<{
        message: string;
        result: boolean;
    }>

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

$checkPhone

  • $checkPhone(): Promise<{
        message: string;
        result: boolean;
    }>

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

$checkUsername

  • $checkUsername(): Promise<{
        message: string;
        result: boolean;
    }>

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

$delete

  • $delete(): Promise<boolean>

  • Delete the object from storage.

    Returns Promise<boolean>

    True on success, false on failure.

$equals

  • $equals(object): boolean

  • Perform a more strict comparison of this object to another.

    Parameters

    • object: any

      The object to compare.

    Returns boolean

    True or false.

$gatekeeper

$getAvatar

$getNewTOTPSecret

  • $getNewTOTPSecret(): Promise<{
        qrcode: string;
        secret: string;
        uri: string;
    }>

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

$getPatch

  • $getPatch(): EntityPatch

  • Get a patch of this entity's dirty data to be applied on the server.

    Returns EntityPatch

$hasTOTPSecret

$hasTag

  • $hasTag(...tags): boolean

  • Check that the entity has all of the given tags.

    Parameters

    • Rest ...tags: string[]

      List of tags.

    Returns boolean

    True or false.

$inArray

  • $inArray(array, strict?): 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.

    • Optional strict: boolean

      Whether to use stronger comparison.

    Returns boolean

    True if the object is in the array, false if it isn't.

$init

$is

  • $is(object): boolean

  • Perform a less strict comparison of this object to another.

    Parameters

    • object: any

      The object to compare.

    Returns boolean

    True or false.

$logout

$patch

  • $patch(): Promise<boolean>

  • Save the object's dirty data to storage.

    Returns Promise<boolean>

    True on success, false on failure.

Protected $referenceSleep

$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.

$register

  • $register(data): Promise<{
        loggedin: boolean;
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          password: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • password: string

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

$removeTOTPSecret

  • $removeTOTPSecret(data?): Promise<{
        message: string;
        result: boolean;
    }>

  • Parameters

    • Optional data: {
          code: string;
          password: string;
      }
      • code: string
      • password: string

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

$removeTag

  • $removeTag(...tags): void

  • Remove one or more tags.

    Parameters

    • Rest ...tags: string[]

      List of tags.

    Returns void

$revokeCurrentTokens

  • $revokeCurrentTokens(data): Promise<{
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          password: string;
      }
      • password: string

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

$save

  • $save(): Promise<boolean>

  • Save the object to storage.

    Returns Promise<boolean>

    True on success, false on failure.

$saveTOTPSecret

  • $saveTOTPSecret(data): Promise<{
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          code: string;
          password: string;
          secret: string;
      }
      • code: string
      • password: string
      • secret: string

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

$serverCall

  • $serverCall(method, params, stateless?): 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.

    • Optional stateless: 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.

$switchUser

  • $switchUser(data?): Promise<{
        message: string;
        result: boolean;
    }>

  • Parameters

    • Optional data: {
          additionalData?: {
              [k: string]: any;
          };
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any

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

$toReference

$wake

$wakeAll

  • $wakeAll(level?): Promise<Entity<UserData>>

  • Ready this entity's data, and the data of entity's within this one's.

    Parameters

    • Optional level: 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.

toJSON

Static current

  • current(returnObjectIfNotExist): Promise<User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | (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...);
        };
        groups?: (Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | (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...);
        })[];
        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?: null | (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...);
        };
        groups?: (Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | (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...);
        })[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    }>

  • current(returnObjectIfNotExist?): Promise<null | User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | (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...);
        };
        groups?: (Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | (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...);
        })[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    }>

  • Parameters

    • Optional returnObjectIfNotExist: false

    Returns Promise<null | User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | (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...);
        };
        groups?: (Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | (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...);
        })[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    }>

Static factory

  • factory<E>(this, guid?): 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

    Parameters

    • this: (new () => E)
        • new (): E

        • Returns E

    • Optional guid: string

      An optional GUID to retrieve.

    Returns Promise<E & EntityDataType<E>>

Static factoryReference

  • factoryReference<E>(this, reference): 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

    Parameters

    • this: (new () => E)
        • new (): E

        • Returns E

    • reference: EntityReference

      The Nymph Entity Reference to use to wake.

    Returns E & EntityDataType<E>

    The new instance.

Static factorySync

Static factoryUsername

Static getClientConfig

Private Static handleToken

Static init

Static loginUser

  • loginUser(data): Promise<{
        message: string;
        needTOTP?: true;
        result: boolean;
        user?: User & UserData & {
            abilities?: string[];
            email?: string;
            group?: Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: null | (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...);
            };
            groups?: (Group & GroupData & {
                abilities?: (...)[];
                email?: string;
                phone?: string;
                user?: null | (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...);
            })[];
            inheritAbilities?: boolean;
            newEmailAddress?: string;
            phone?: string;
        };
    }>

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          code?: string;
          password: string;
          username: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • Optional 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?: null | (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...);
            };
            groups?: (Group & GroupData & {
                abilities?: (...)[];
                email?: string;
                phone?: string;
                user?: null | (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...);
            })[];
            inheritAbilities?: boolean;
            newEmailAddress?: string;
            phone?: string;
        };
    }>

Static off

Static on

Static recover

  • recover(data): Promise<{
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          password: string;
          secret: string;
          username: string;
      }
      • password: string
      • secret: string
      • username: string

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

Static sendRecovery

  • sendRecovery(data): Promise<{
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          account: string;
          recoveryType: "username" | "password";
      }
      • account: string
      • recoveryType: "username" | "password"

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

Static serverCallStatic

  • serverCallStatic(method, params): 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.

Static serverCallStaticIterator

  • serverCallStaticIterator(method, params): 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.

Settings

Member Visibility

Theme

On This Page

constructor$data$dataHandler$dataStore$dirty$isASleepingReference$nymph$originalTags$sleepingReference$wakePromisecdateguidmdatetagsclassnymphstores$addTag$arraySearch$asleep$changePassword$check$checkEmail$checkPhone$checkUsername$delete$equals$gatekeeper$getAvatar$getNewTOTPSecret$getPatch$hasTOTPSecret$hasTag$inArray$init$is$logout$patch$referenceSleep$refresh$register$removeTOTPSecret$removeTag$revokeCurrentTokens$save$saveTOTPSecret$serverCall$switchUser$toReference$wake$wakeAlltoJSONcurrentfactoryfactoryReferencefactorySyncfactoryUsernamegetClientConfighandleTokeninitloginUseroffonrecoversendRecoveryserverCallStaticserverCallStaticIterator