https://github.com/octokit/auth-unauthenticated.js
strategy for explicitly unauthenticated Octokit instances
https://github.com/octokit/auth-unauthenticated.js
hacktoberfest octokit-js plugin
Last synced: 7 months ago
JSON representation
strategy for explicitly unauthenticated Octokit instances
- Host: GitHub
- URL: https://github.com/octokit/auth-unauthenticated.js
- Owner: octokit
- License: mit
- Created: 2020-08-03T23:30:14.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-20T06:22:47.000Z (8 months ago)
- Last Synced: 2025-05-20T06:26:35.020Z (8 months ago)
- Topics: hacktoberfest, octokit-js, plugin
- Language: TypeScript
- Homepage:
- Size: 1.6 MB
- Stars: 6
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# auth-unauthenticated.js
> strategy for explicitly unauthenticated Octokit instances
[](https://www.npmjs.com/package/@octokit/auth-unauthenticated)
[](https://github.com/octokit/auth-unauthenticated.js/actions?query=workflow%3ATest)
`@octokit/auth-unauthenticated` is useful for cases when an Octokit constructor has a default authentication strategy, but you require an explicitly unauthenticated instance.
One use cases is when building a GitHub App using [`@octokit/auth-app`](https://github.com/octokit/auth-app.js) and handling webhooks using [`@octokit/webhooks`](https://github.com/octokit/webhooks.js). While all webhook events provide an installation ID in its payload, in case of the `installation.deleted` event, the app can no longer create an installation access token, because the app's access has been revoked.
- [Usage](#usage)
- [`createUnauthenticatedAuth() options`](#createunauthenticatedauth-options)
- [`auth()`](#auth)
- [Authentication object](#authentication-object)
- [`auth.hook(request, route, options)` or `auth.hook(request, options)`](#authhookrequest-route-options-or-authhookrequest-options)
- [License](#license)
## Usage
Browsers
Load `@octokit/auth-unauthenticated` directly from [esm.sh](https://esm.sh)
```html
import { createUnauthenticatedAuth } from "https://esm.sh/@octokit/auth-unauthenticated";
```
Node
Install with npm install @octokit/auth-unauthenticated
```js
import { createUnauthenticatedAuth } from "@octokit/auth-unauthenticated";
```
> [!IMPORTANT]
> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`.
>
> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
```js
const auth = createUnauthenticatedAuth({
reason:
"Handling an installation.deleted event (The app's access has been revoked)",
});
const authentication = await auth();
// {
// type: 'unauthenticated',
// reason: 'Handling an installation.deleted event (The app's access has been revoked)'
// }
```
## `createUnauthenticatedAuth() options`
The `createUnauthenticatedAuth` method requires an `options.reason` argument which will be used when returning an error due to a lack of authentication or when logging a warning in case of a `404` error.
Examples
```js
createUnauthenticatedAuth({
reason:
"Handling an installation.deleted event: The app's access has been revoked from @octokit (id: 12345)",
});
```
## `auth()`
The `auth()` method accepts any options, but it doesn't do anything with it. That makes it a great drop-in replacement for any other authentication strategy.
## Authentication object
name
type
description
type
string
"unauthenticated"
## `auth.hook(request, route, options)` or `auth.hook(request, options)`
`auth.hook()` hooks directly into the request life cycle. If a mutating request is attempted to be sent (`DELETE`, `PATCH`, `POST`, or `PUT`), the request is failed immediately and returning an error that contains the reason passed to `createUnauthenticatedAuth({ reason })`.
If a request fails with a `404` or due to hitting a rate/abuse limit, the returned error is amended that it might be caused due to a lack of authentication and will include the reason passed to `createUnauthenticatedAuth({ reason })`.
The `request` option is an instance of [`@octokit/request`](https://github.com/octokit/request.js#readme). The `route`/`options` parameters are the same as for the [`request()` method](https://github.com/octokit/request.js#request).
`auth.hook()` can be called directly to send an authenticated request
```js
const { data } = await auth.hook(request, "GET /");
```
Or it can be passed as option to [`request()`](https://github.com/octokit/request.js#request).
```js
const requestWithAuth = request.defaults({
request: {
hook: auth.hook,
},
});
const { data } = await requestWithAuth("GET /");
```
## License
[MIT](LICENSE)