Class GitHubStrategy<User>

Type Parameters

  • User

Hierarchy

Constructors

constructor

Properties

name options sessionCodeVerifierKey sessionStateKey verify

Methods

authenticate authorizationParams failure refreshToken revokeToken success userEmails userProfile

Constructors

constructor

Properties

name

name: string = GitHubStrategyDefaultName

Protectedoptions

options: OAuth2StrategyOptions

ProtectedsessionCodeVerifierKey

sessionCodeVerifierKey: string

ProtectedsessionStateKey

sessionStateKey: string

Protectedverify

verify: StrategyVerifyCallback<User, OAuth2StrategyVerifyParams<GitHubProfile, GitHubExtraParams>>

Methods

authenticate

  • authenticate(request, sessionStorage, options): Promise<User>

  • The authentication flow of the strategy.

    This method receives the Request to authenticator and the session storage to use from the Authenticator. It may receive a custom callback.

    At the end of the flow, it will return a Response to be used by the application.

    Parameters

    • request: Request
    • sessionStorage: SessionStorage<SessionData, SessionData>
    • options: AuthenticateOptions

    Returns Promise<User>

ProtectedauthorizationParams

  • authorizationParams(params): URLSearchParams

  • Return extra parameters to be included in the authorization request.

    Some OAuth 2.0 providers allow additional, non-standard parameters to be included when requesting authorization. Since these parameters are not standardized by the OAuth 2.0 specification, OAuth 2.0-based authentication strategies can override this function in order to populate these parameters as required by the provider.

    Parameters

    Returns URLSearchParams

Protectedfailure

  • failure(message, request, sessionStorage, options, cause?): Promise<never>

  • Throw an AuthorizationError or a redirect to the failureRedirect.

    Parameters

    • message: string

      The error message to set in the session.

    • request: Request

      The request to get the cookie out of.

    • sessionStorage: SessionStorage<SessionData, SessionData>

      The session storage to retrieve the session from.

    • options: AuthenticateOptions

      The strategy options.

    • Optionalcause: Error

    Returns Promise<never>

    Throws

    If the throwOnError is set to true.

    Throws

    If the failureRedirect is set or throwOnError is false.

refreshToken

  • refreshToken(refreshToken, options?): Promise<Body & GitHubExtraParams>

  • Get new tokens using a refresh token.

    Parameters

    • refreshToken: string

      The refresh token to use

    • Optionaloptions: Partial<Pick<OAuth2StrategyOptions, "scopes">> & {
          signal?: AbortSignal;
      }

      Optional options to override the default strategy options

    Returns Promise<Body & GitHubExtraParams>

    A promise that resolves to the new tokens

revokeToken

  • revokeToken(token, options?): Promise<void>

  • Parameters

    • token: string
    • Optionaloptions: {
          signal?: AbortSignal;
          tokenType?: "access_token" | "refresh_token";
      }
      • Optionalsignal?: AbortSignal
      • OptionaltokenType?: "access_token" | "refresh_token"

    Returns Promise<void>

Protectedsuccess

  • success(user, request, sessionStorage, options): Promise<User>

  • Returns the user data or throw a redirect to the successRedirect.

    Parameters

    • user: User

      The user data to set in the session.

    • request: Request

      The request to get the cookie out of.

    • sessionStorage: SessionStorage<SessionData, SessionData>

      The session storage to retrieve the session from.

    • options: AuthenticateOptions

      The strategy options.

    Returns Promise<User>

    The user data.

    Throws

    If the successRedirect is set, it will redirect to it.

ProtecteduserEmails

  • userEmails(accessToken): Promise<{
        type?: string;
        value: string;
    }[]>

  • Parameters

    • accessToken: string

    Returns Promise<{
        type?: string;
        value: string;
    }[]>

ProtecteduserProfile

Settings

Member Visibility

On This Page

Constructors
Properties
Methods