class JwtService {
sign(payload: string | object | Buffer, options?: JwtSignOptions): string
signAsync(payload: string | object | Buffer, options?: JwtSignOptions): Promise<string>
verify<T extends object = any>(token: string, options?: JwtVerifyOptions): T
verifyAsync<T extends object = any>(token: string, options?: JwtVerifyOptions): Promise<T>
decode(token: string, options?: jwt.DecodeOptions): null | {...}
}
Methods
sign()
|
|---|
sign(payload: string, options?: Omit<JwtSignOptions, string | number | symbol>): string
Parameters
| Option |
Type |
Description |
payload
|
string |
|
options
|
Omit |
Optional. Default is undefined.
|
Returns
string
|
sign(payload: object | Buffer, options?: JwtSignOptions): string
Parameters
| Option |
Type |
Description |
payload
|
object | Buffer |
|
options
|
JwtSignOptions |
Optional. Default is undefined.
|
Returns
string
|
signAsync()
|
|---|
signAsync(payload: string, options?: Omit<JwtSignOptions, string | number | symbol>): Promise<string>
Parameters
| Option |
Type |
Description |
payload
|
string |
|
options
|
Omit |
Optional. Default is undefined.
|
Returns
Promise<string>
|
signAsync(payload: object | Buffer, options?: JwtSignOptions): Promise<string>
Parameters
| Option |
Type |
Description |
payload
|
object | Buffer |
|
options
|
JwtSignOptions |
Optional. Default is undefined.
|
Returns
Promise<string>
|
verify()
|
|---|
verify<T extends object = any>(token: string, options?: JwtVerifyOptions): T
Parameters
| Option |
Type |
Description |
token
|
string |
|
options
|
JwtVerifyOptions |
Optional. Default is undefined.
|
Returns
T
|
verifyAsync()
|
|---|
verifyAsync<T extends object = any>(token: string, options?: JwtVerifyOptions): Promise<T>
Parameters
| Option |
Type |
Description |
token
|
string |
|
options
|
JwtVerifyOptions |
Optional. Default is undefined.
|
Returns
Promise<T>
|
decode()
|
|---|
decode(token: string, options?: jwt.DecodeOptions): null | {
[key: string]: any;
} | string
Parameters
| Option |
Type |
Description |
token
|
string |
|
options
|
jwt.DecodeOptions |
Optional. Default is undefined.
|
Returns
null | {
[key: string]: any;
} | string
|
