remix/middleware/auth · Function

View Source

auth

Summary

Loads auth state for the current request by running each configured auth scheme in order.

Signature

function auth<schemes extends readonly AuthScheme<any>[]>(
  options: AuthOptions<schemes>,
): Middleware<{
  key: ContextKey<AuthState<unknown>>
  property: 'auth'
  value: AuthForSchemes<schemes>
}>

Parameters

options

Auth scheme configuration for the middleware.

Returns

Middleware that resolves auth state into context.auth and context.get(Auth).