Class SalteAuth

Hierarchy

Shared
- SalteAuth

Index

Constructors

constructor

Properties

Accessors

key

Methods

Constructors

constructor

new SalteAuth(config: Config): SalteAuth

Inherited from Shared.constructor
- Defined in src/salte-auth.ts:13
Parameters
- config: Config
Returns SalteAuth

Properties

config

config: Config

logger

logger: Logger

mixin

mixin: (base: Constructor<{ requestUpdate?: any }>) => SalteAuthMixedIn<{ auth: SalteAuth }>

Type declaration

- (base: Constructor<{ requestUpdate?: any }>): SalteAuthMixedIn<{ auth: SalteAuth }>
- Parameters
  - base: Constructor<{ requestUpdate?: any }>
  Returns SalteAuthMixedIn<{ auth: SalteAuth }>

storage

storage: CookieStorage | LocalStorage | SessionStorage

Accessors

key

get key(): string

- Defined in src/base/core/storage.ts:35
Returns string

Methods

Private $secure

$secure(provider: Provider, request?: ExtendedXMLHttpRequest | Request): Promise<void>

- Defined in src/salte-auth.ts:247
Parameters
- provider: Provider
- Optional request: ExtendedXMLHttpRequest | Request
Returns Promise<void>

emit

emit(name: "login" | "logout", error?: Error, data?: EventWrapper): void

Overrides Shared.emit
- Defined in src/salte-auth.ts:276
Parameters
- name: "login" | "logout"
- Optional error: Error
- Optional data: EventWrapper
Returns void

handler

handler(name?: string): Handler

- Defined in src/salte-auth.ts:232
Returns a handler that matches the given name.

Parameters
- Optional name: string
  
  the name of the handler
Returns Handler

the handler with the given name, if no name is specified then the default handler.

login

login(options: AuthOptions): Promise<void>
login(provider: string): Promise<void>

- Defined in src/salte-auth.ts:125
Login to the specified provider.

Parameters
- options: AuthOptions
  
  the authentication options
Returns Promise<void>
- Defined in src/salte-auth.ts:131
Login to the specified provider.

Parameters
- provider: string
  
  the provider to login with
Returns Promise<void>

logout

logout(options: AuthOptions): Promise<void>
logout(provider: string): Promise<void>

- Defined in src/salte-auth.ts:168
Logout of the specified provider.

Parameters
- options: AuthOptions
  
  the authentication options
Returns Promise<void>
- Defined in src/salte-auth.ts:174
Logout of the specified provider.

Parameters
- provider: string
  
  the provider to logout of
Returns Promise<void>

off

off(name: string, listener: Function): void

Inherited from Shared.off
- Defined in src/base/core/events.ts:16
Parameters
- name: string
- listener: Function
Returns void

on

on(name: "login", listener: (error?: Error, data?: EventWrapper) => void): void
on(name: "logout", listener: (error?: Error, data?: EventWrapper) => void): void

Overrides Shared.on
- Defined in src/salte-auth.ts:274
Parameters
- name: "login"
- listener: (error?: Error, data?: EventWrapper) => void
  - - (error?: Error, data?: EventWrapper): void
    - Parameters
      - Optional error: Error
      - Optional data: EventWrapper
      Returns void
Returns void
- Defined in src/salte-auth.ts:275
Parameters
- name: "logout"
- listener: (error?: Error, data?: EventWrapper) => void
  - - (error?: Error, data?: EventWrapper): void
    - Parameters
      - Optional error: Error
      - Optional data: EventWrapper
      Returns void
Returns void

provider

provider(name?: string): Provider

- Defined in src/salte-auth.ts:214
Returns a provider that matches the given name.

Parameters
- Optional name: string
  
  the name of the provider
Returns Provider

the provider with the given name.

redirectUrl

redirectUrl(type: "login" | "logout"): string

Inherited from Shared.redirectUrl
- Defined in src/base/core/shared.ts:19
Returns a redirect url for the given login type.

Parameters
- type: "login" | "logout"
  
  Are we logging in or logging out?
Returns string

Protected required

required(...keys: string[]): void

Inherited from Shared.required
- Defined in src/base/core/required.ts:8
Parameters
- Rest ...keys: string[]
Returns void

Generated using TypeDoc