Providers

@quik/passport

---

@quik/passport / Providers

Variable: Providers

const Providers: object

Defined in: passport/src/providers/index.ts:4

Type Declaration

all

all: () => Record<string, OAuthProviderDefinition> = getOAuthProviders

Return all known OAuth providers.

Returns

Record<string, OAuthProviderDefinition>

Decorators

Decorators: object = OAuthProviderDecorators

Decorators.Callback

Callback: (providerName, options?) => <This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

Decorator that handles the callback from an OAuth provider.

Parameters

providerName

string

Provider identifier.

options?

AuthenticateOptions

Additional authentication options.

Returns

<This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

Decorators.Redirect

Redirect: (providerName, options?) => <This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

Decorator that redirects a request to the selected OAuth provider.

Parameters

providerName

string

Provider identifier.

options?

AuthenticateOptions

Additional authentication options.

Returns

<This, Args, Return>(target, context) => MethodDecoratorType<This, Args, Return>

get

get: (name) => OAuthProviderDefinition = getOAuthProvider

Returns one OAuth provider by name.

Parameters

name

string

Provider name.

Returns

OAuthProviderDefinition

register

register: (provider) => void = registerOAuthProvider

Register an OAuth provider definition.

Parameters

provider

OAuthProviderDefinition

Provider registration details.

Returns

void

registerAll

registerAll: () => void = registerOAuthProviders

Registers all OAuth providers in the passport runtime.

Returns

void

registerBatch

registerBatch: (providers) => void = registerOAuthProviderBatch

Register multiple OAuth providers in one call.

Parameters

providers

OAuthProviderDefinition[]

Provider list.

Returns

void