Back to Encore

encore.dev/auth

docs/ts/runtime/auth.mdx

1.57.51.3 KB
Original Source

Type Aliases

<!-- symbol-start: AuthHandler -->

AuthHandler <SymbolSource href="https://github.com/encoredev/encore/blob/main/runtimes/js/encore.dev/auth/mod.ts#L1" />

type AuthHandler<Params, AuthData> = (params) => Promise<AuthData | null> & AuthHandlerBrand

Type Parameters

Params

Params extends object

AuthData

AuthData extends { userID: string; }


<!-- symbol-end --> <!-- symbol-start: AuthHandlerBrand -->

AuthHandlerBrand <SymbolSource href="https://github.com/encoredev/encore/blob/main/runtimes/js/encore.dev/auth/mod.ts#L6" />

ts
type AuthHandlerBrand = {
  __authHandlerBrand: unique symbol;
};

Properties

__authHandlerBrand

readonly __authHandlerBrand: unique symbol

<!-- symbol-end -->

Functions

<!-- symbol-start: authHandler() -->

authHandler() <SymbolSource href="https://github.com/encoredev/encore/blob/main/runtimes/js/encore.dev/auth/mod.ts#L8" />

function authHandler<Params, AuthData>(fn): AuthHandler<Params, AuthData>

Type Parameters

Params

Params extends object

AuthData

AuthData extends { userID: string; }

Parameters

fn

(params) => Promise<AuthData | null>

Returns

AuthHandler<Params, AuthData>

<!-- symbol-end -->