Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Provider

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

config

config: Config

dedupe

dedupe: Function = ...

Protected logger

logger: Logger

login

login: string

Returns the login url for the provider.

name

name: string

The unique name of the provider

storage

storage: CookieStorage | LocalStorage | SessionStorage

Protected url

url: (base: string, params?: {}) => string = ...

Type declaration

    • (base: string, params?: {}): string

    • Creates a url with the given query parameters

      Parameters

      • base: string

        the base url without query parameters

      • Optional params: {}

        the query parameters to attache to the url

        • [key: string]: any

      Returns string

      the built url

Accessors

$name

  • get $name(): string

key

  • get key(): string

  • Returns a scoped key for storage.

    example

    auth0.key('hello') // 'salte.auth.provider.auth0.hello'

    Returns string

logout

  • get logout(): string

Methods

$login

  • $login(options?: object): string

  • An internal login command to salte-auth that enables enhancing the login with common parameters.

    Parameters

    • Optional options: object

    Returns string

$validate

  • $validate(options: object): void

Optional connected

  • connected(): void

emit

  • emit(name: string, ...args: any[]): void

off

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

on

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

  • Parameters

    • name: "login"
    • listener: (error?: Error, data?: any) => void
        • (error?: Error, data?: any): void

        • Parameters

          • Optional error: Error
          • Optional data: any

          Returns void

    Returns void

  • Parameters

    • name: "logout"
    • listener: (error?: Error) => void
        • (error?: Error): void

        • Parameters

          • Optional error: Error

          Returns void

    Returns void

redirectUrl

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

Protected required

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

Optional secure

  • Invoked when an endpoint is marked as secured.

    Parameters

    Returns Promise<boolean | "login">

    true if the endpoint is already secured, otherwise it returns a url to secure the endpoint.

sync

  • sync(): void

validate

  • validate(options: void | object): void

Protected validation

  • validation(key: string): boolean

  • Determines if validation is enabled for the given key.

    Parameters

    • key: string

      the key to determine whether validation is enabled for

    Returns boolean

    whether validation is enabled for the key.

Generated using TypeDoc