remix/auth · Interface

View Source

CredentialsAuthProviderOptions

Summary

Options for building a credentials-based auth provider.

Signature

interface CredentialsAuthProviderOptions<input, result, provider> {
  name?: provider
  parse(context: RequestContext): input | Promise<input>
  verify(input: input, context: RequestContext): result | Promise<result | null> | null
}

Properties

name

Provider name used for session metadata and diagnostics.

Methods

parse(context: RequestContext): input | Promise<input>

Parses submitted credentials from the current request.

verify(input: input, context: RequestContext): result | Promise<result | null> | null

Verifies parsed credentials and returns the authenticated result on success.