Skip to main content

Class: Auth

Constructors

new Auth()

private new Auth(options: ServerOptionsAuth): Auth

Parameters

ParameterType
optionsServerOptionsAuth

Returns

Auth

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:49

Properties

#secret

private #secret: string

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:47


cookie: string

The name for the cookie, this will be used to identify a Secure HttpOnly cookie.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:25


domainOverwrite

domainOverwrite: null | string = null

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:45


id

id: string

The client's application id, this can be retrieved in Discord Developer Portal at https://discord.com/developers/applications.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:19


redirect

redirect: undefined | string

The redirect uri.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:37


scopes

scopes: readonly OAuth2Scopes[]

The scopes defined at https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:31


transformers

transformers: LoginDataTransformer <LoginData>[]

The transformers used for Auth.fetchData.

Since

1.4.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:43

Accessors

secret

get secret(): string

The client secret, this can be retrieved in Discord Developer Portal at https://discord.com/developers/applications.

Since

1.0.0

Returns

string

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:63

Methods

decrypt()

decrypt(token: string): null | AuthData

Decrypts an object with aes-256-cbc to use as a token.

Parameters

ParameterTypeDescription
tokenstringAn data to decrypt

Returns

null | AuthData

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:83


encrypt()

encrypt(data: AuthData): string

Encrypts an object with aes-256-cbc to use as a token.

Parameters

ParameterTypeDescription
dataAuthDataAn object to encrypt

Returns

string

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:72


fetchData()

fetchData(token: string): Promise <LoginData>

Retrieves the data for a specific user.

Parameters

ParameterTypeDescription
tokenstringThe access token from the user.

Returns

Promise <LoginData>

Since

1.4.0

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:101


fetchInformation()

private fetchInformation<T>(scope: OAuth2Scopes, token: string, url: string): Promise<undefined | null | T>

Type parameters

Type parameter
T

Parameters

ParameterType
scopeOAuth2Scopes
tokenstring
urlstring

Returns

Promise<undefined | null | T>

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:124


create()

static create(options?: ServerOptionsAuth): null | Auth

Parameters

ParameterType
options?ServerOptionsAuth

Returns

null | Auth

Source

projects/plugins/packages/api/src/lib/structures/http/Auth.ts:136