UNPKG

@digitalpersona/core

Version:
38 lines (25 loc) 1.54 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@digitalpersona/core](./core.md) &gt; [User](./core.user.md) ## User class Represents a user's identity using a user's name name and a type of the name. This class is typially used to pass a user name during authentication. <b>Signature:</b> ```typescript export declare class User ``` ## Constructors | Constructor | Modifiers | Description | | --- | --- | --- | | [(constructor)(name, type)](./core.user.(constructor).md) | | Constructs the object using a username and a user type. | ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [name](./core.user.name.md) | | <code>string</code> | User name. Must be defined in one of supported formats (see [UserNameType](./core.usernametype.md)<!-- -->) | | [type](./core.user.type.md) | | <code>UserNameType</code> | Format of the user name | ## Methods | Method | Modifiers | Description | | --- | --- | --- | | [Anonymous()](./core.user.anonymous.md) | <code>static</code> | Creates a user object representing an anonymous user. | | [Everyone()](./core.user.everyone.md) | <code>static</code> | Creates a user object representing every user. | | [fromJWT(token, type)](./core.user.fromjwt.md) | <code>static</code> | Creates a user object using claims in a JSON Web Token. | | [isAnonymous()](./core.user.isanonymous.md) | | | | [isEveryone()](./core.user.iseveryone.md) | | |