Options
All
  • Public
  • Public/Protected
  • All
Menu

Module octokit/get-probot-octokit-with-defaults

Index

Functions

getProbotOctokitWithDefaults

  • getProbotOctokitWithDefaults(options: Options): typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>
  • Returns an Octokit instance with default settings for authentication. If a githubToken is passed explicitly, the Octokit instance will be pre-authenticated with that token when instantiated. Otherwise Octokit's app authentication strategy is used, and options.auth options are merged deeply when instantiated.

    Besides the authentication, the Octokit's baseUrl is set as well when run against a GitHub Enterprise Server with a custom domain.

    Parameters

    • options: Options

    Returns typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>

Generated using TypeDoc