Class Authenticator<User>

Create a new instance of the Authenticator.

It receives a instance of a Cookie created using Remix's createCookie.

It optionally receives an object with extra options. The supported options are:

Example

let auth = new Authenticator();

Type Parameters

  • User = unknown

Constructors

constructor

Methods

authenticate get unuse use

Constructors

constructor

Methods

authenticate

  • authenticate(strategy: string, request: Request): Promise<User>

  • Call this to authenticate a request using some strategy. You pass the name of the strategy you want to use and the request to authenticate.

    Parameters

    Returns Promise<User>

    Example

    async function action({ request }: ActionFunctionArgs) {
      let user = await auth.authenticate("strategy-name", request);
    };

get

  • get(name: string): null | Strategy<User, never>

  • Call this method with the name of a strategy you want to get. It returns the Strategy instance or null if the strategy is not found.

    Parameters

    • name: string

    Returns null | Strategy<User, never>

unuse

  • unuse(name: string): Authenticator<unknown>

  • Call this method with the name of the strategy you want to remove. It returns the Authenticator instance for concatenation.

    Parameters

    • name: string

    Returns Authenticator<unknown>

    Example

    auth.unuse("another").unuse("some");

use

  • use(strategy: Strategy<User, never>, name?: string): Authenticator<User>

  • Call this method with the Strategy, the optional name allows you to setup the same strategy multiple times with different names. It returns the Authenticator instance for concatenation.

    Parameters

    Returns Authenticator<User>

    Example

    auth.use(new SomeStrategy((user) => Promise.resolve(user)));
    auth.use(new SomeStrategy((user) => Promise.resolve(user)), "another");

Settings

Member Visibility

On This Page

Constructors
Methods