Class GitHubStrategy<User>

Type Parameters

User

Hierarchy

Strategy<User, VerifyOptions>
- GitHubStrategy

Index

Constructors

Properties

client name options verify

Methods

authenticate authorizationParams refreshToken

Constructors

constructor

new GitHubStrategy<User>(
options: ConstructorOptions,
verify: VerifyFunction<User, VerifyOptions>,
): GitHubStrategy<User>
Type Parameters
- User
Parameters
- options: ConstructorOptions
- verify: VerifyFunction<User, VerifyOptions>
Returns GitHubStrategy<User>
Overrides Strategy< User, GitHubStrategy.VerifyOptions >.constructor
- Defined in src/index.ts:32

Properties

`Protected`client

client: GitHub

name

name: string = "github"

The name of the strategy. This will be used by the Authenticator to identify and retrieve the strategy.

`Protected`options

options: ConstructorOptions

`Protected`verify

verify: VerifyFunction<User, VerifyOptions>

Methods

authenticate

authenticate(request: Request): Promise<User>
The authentication flow of the strategy.

This method receives the Request from the authenticator we want to authenticate.

At the end of the flow, it will return a the User data to be used by the application.
Parameters
- request: Request
Returns Promise<User>
Overrides Strategy.authenticate
- Defined in src/index.ts:57

`Protected`authorizationParams

authorizationParams(params: URLSearchParams, request: Request): 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
- params: URLSearchParams
- request: Request
Returns URLSearchParams
- Defined in src/index.ts:139

refreshToken

refreshToken(refreshToken: string): Promise<OAuth2Tokens>
Get a new OAuth2 Tokens object using the refresh token once the previous access token has expired.
Parameters
- refreshToken: string
  The refresh token to use to get a new access token
Returns Promise<OAuth2Tokens>
The new OAuth2 tokens object
Example
```
let tokens = await strategy.refreshToken(refreshToken);
console.log(tokens.accessToken());
```
- Defined in src/index.ts:157