Interface: UserProvider

Used to type the socket.data.user attribute with the correct user provider. This interface is exposed to allow type augmentation.

Extends

• AccessTokensUserProviderContract<unknown>

Properties

Property	Type	Inherited from
[PROVIDER_REAL_USER]	unknown	AccessTokensUserProviderContract.[PROVIDER_REAL_USER]

Methods

createToken()

createToken(
   user: unknown,
   abilities?: string[],
   options?: {
  expiresIn: string | number;
  name: string;
}): Promise<AccessToken>;

Create a token for a given user

Parameters

Parameter	Type
user	unknown
abilities?	string[]
options?	{ expiresIn: string | number; name: string; }
options.expiresIn?	string | number
options.name?	string

Returns

Promise<AccessToken>

Inherited from

AccessTokensUserProviderContract.createToken;

---

createUserForGuard()

createUserForGuard(user: unknown): Promise<AccessTokensGuardUser<unknown>>;

Create a user object that acts as an adapter between the guard and real user value.

Parameters

Parameter	Type
user	unknown

Returns

Promise<AccessTokensGuardUser<unknown>>

Inherited from

AccessTokensUserProviderContract.createUserForGuard;

---

findById()

findById(identifier: string | number | BigInt): Promise<null | AccessTokensGuardUser<unknown>>;

Find a user by the user id.

Parameters

Parameter	Type
identifier	string | number | BigInt

Returns

Promise<null | AccessTokensGuardUser<unknown>>

Inherited from

AccessTokensUserProviderContract.findById;

---

invalidateToken()

invalidateToken(tokenValue: Secret<string>): Promise<boolean>;

Invalidates a token identified by its publicly shared token.

Parameters

Parameter	Type
tokenValue	Secret<string>

Returns

Promise<boolean>

Inherited from

AccessTokensUserProviderContract.invalidateToken;

---

verifyToken()

verifyToken(tokenValue: Secret<string>): Promise<null | AccessToken>;

Verify a token by its publicly shared value.

Parameters

Parameter	Type
tokenValue	Secret<string>

Returns

Promise<null | AccessToken>

Inherited from

AccessTokensUserProviderContract.verifyToken;