DOCUMENTATION.md

Documentation

You can see below the API reference of this module.

Plugin Configuration

• Object config:
• loginURI (String): The application login url.
• callbackURI(String): The application login callback url.
• githubClient (String): The application client id.
• githubSecret (String): The application client secret.
• scope (String): The user scopes (default: user:email).

To create a GitHub application, click here.

Events

⬆️ The following events are emitted by the module:

• login-error (err, lien, ghApiClient)

  An error happened durring the error.

• login-success (token, user, ctx, ghApiClient)

  The user metadata was fetched. If you don't want to fetch

• token (token, ctx, ghApiClient)

  Emitted when the token is successfully got.