Hierarchy

Constructors

Properties

$data: UserData
$dataHandler: Object
$dataStore: UserData
$dirty: {
    [k: string]: boolean;
}

Type declaration

  • [k: string]: boolean
$isASleepingReference: boolean
$nymph: default
$originalTags: string[]
$sleepingReference: null | EntityReference
$wakePromise: null | Promise<default<UserData>>
cdate: null | number
guid: null | string
mdate: null | number
tags: string[]
class: string = 'User'
nymph: default
stores: WeakMap<default, InstanceStore> = ...

Methods

  • Parameters

    • Rest ...tags: string[]

    Returns void

  • Parameters

    • array: any[]
    • Optional strict: boolean

    Returns number

  • Returns boolean

  • Parameters

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

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

  • Returns void

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

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

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

  • Returns Promise<boolean>

  • Parameters

    • object: any

    Returns boolean

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

  • Returns EntityPatch

  • Parameters

    • Rest ...tags: string[]

    Returns boolean

  • Parameters

    • array: any[]
    • Optional strict: boolean

    Returns boolean

  • Parameters

    • entityJson: null | EntityJson

    Returns default<UserData>

  • Parameters

    • object: any

    Returns boolean

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

  • Returns Promise<boolean>

  • Parameters

    • reference: EntityReference

    Returns void

  • Returns Promise<boolean | 0>

  • 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;
    }>

  • Parameters

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

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

  • Parameters

    • Rest ...tags: string[]

    Returns void

  • Parameters

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

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

  • Returns Promise<boolean>

  • Parameters

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

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

  • Parameters

    • method: string
    • params: Iterable<any>
    • Optional stateless: boolean

    Returns Promise<any>

  • Parameters

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

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

  • Returns EntityReference | EntityInterface

  • Returns Promise<default<UserData>>

  • Parameters

    • Optional level: number

    Returns Promise<default<UserData>>

  • Returns EntityJson

  • 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; groups?: (Group & ......);
        };
        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; groups?: (Group & ......);
        })[];
        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; groups?: (Group & ......);
        };
        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; groups?: (Group & ......);
        })[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    }>

  • Parameters

    • reference: EntityReference

    Returns default<EntityData>

  • 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; groups?: (Group & ......);
            };
            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; groups?: (Group & ......);
            })[];
            inheritAbilities?: boolean;
            newEmailAddress?: string;
            phone?: string;
        };
    }>

  • Parameters

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

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

  • Parameters

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

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

  • Parameters

    • method: string
    • params: Iterable<any>

    Returns Promise<any>

  • Parameters

    • method: string
    • params: Iterable<any>

    Returns Promise<AbortableAsyncIterator<any>>

Generated using TypeDoc