auth-app.js | GitHub App authentication for JavaScript | Authentication library

Required. Must be "installation". Required unless a default installationId was passed to createAppAuth(). ID of installation to retrieve authentication for. The id of the repositories that the installation token can access. Also known as a databaseID when querying the repository object in GitHub's GraphQL API. This option is **(recommended)** over repositoryNames when needing to limit the scope of the access token, due to repositoryNames having the possibility of changing. Additionally, you should only include either repositoryIds or repositoryNames, but not both. The name of the repositories that the installation token can access. As mentioned in the repositoryIds description, you should only include either repositoryIds or repositoryNames, but not both. The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see GitHub App permissions. The auth({type: "installation", installationId, factory }) call with resolve with whatever the factory function returns. The factory function will be called with all the strategy option that auth was created with, plus the additional options passed to auth, besides type and factory. For example, you can create a new auth instance for an installation which shares the internal state (especially the access token cache) with the calling auth instance: const appAuth = createAppAuth({ appId: 1, privateKey: "-----BEGIN PRIVATE KEY-----\n...", }); const installationAuth123 = await appAuth({ type: "installation", installationId: 123, factory: createAppAuth, });. Installation tokens expire after one hour. By default, tokens are cached and returned from cache until expired. To bypass and update a cached token for the given installationId, set refresh to true. Defaults to false.
The installation access token. Timestamp in UTC format, e.g. "2018-07-07T00:00:00.000Z". A Date object can be created using new Date(authentication.expiresAt). Timestamp in UTC format, e.g. "2018-07-07T00:59:00.000Z". A Date object can be created using new Date(authentication.expiresAt). Only present if repositoryIds option passed to auth(options). Only present if repositoryNames option passed to auth(options). An object where keys are the permission name and the value is either "read" or "write". See the list of all GitHub App Permissions. If the single file permission is enabled, the singleFileName property is set to the path of the accessible file.