Prune-github-notifications NPM

CLI

prune-github-notifications can be run on the CLI with an auth token for notifications access specified as a GH_TOKEN environment variable:

GH_TOKEN=$(gh auth token) npx prune-github-notifications

Only auth is required, and only if a GH_TOKEN isn't available.

Option	Type	Default	Description
`--auth`	`string`	`process.env.GH_TOKEN`	GitHub authentication token with notifications access.
`--bandwidth`	`number`	`6`	Maximum parallel requests to start at once.
`--reason`	`string[]`	`["subscribed"]`	Notification reason(s) to filter to.
`--title`	`string`	`"^chore\(deps\): update .+ to"`	Notification title regular expression to filter to.
`--watch`	`number`	`0`	A seconds interval to continuously re-run this on, if truthy.

For example, providing all options on the CLI:

npx prune-github-notifications --auth $(gh auth token) --bandwidth 10 --reason subscribed --title "^chore.+ update .+ to"

Running in watch mode to clear notifications every ten seconds:

npx prune-github-notifications --auth $(gh auth token) --watch 10

npm i prune-github-notifications

import { pruneGitHubNotifications } from "prune-github-notifications";

await pruneGitHubNotifications({ auth: "gho_..." });

If a process.env.GH_TOKEN is set, then the auth parameter will default to it:

await pruneGitHubNotifications();

Only auth is required, and only if a GH_TOKEN isn't available.

Option	Type	Default	Description
`auth`	`string`	`process.env.GH_TOKEN`	GitHub authentication token with notifications access.
`bandwidth`	`number`	`6`	Maximum parallel requests to start at once.
`reason`	`Set<string>`	`Set {"subscribed"}`	Notification reason(s) to filter to.
`title`	`RegExp`	`/^chore\(deps\): update .+ to/`	Notification title regular expression to filter to.

For example, providing all options to the Node.js API:

await pruneGitHubNotifications({
	auth: "gho_...",
	bandwidth: 10,
	reason: subscribed,
	title: "^chore.+ update .+ to",
});

💙 This package was templated with create-typescript-app.

14 days ago

2 months ago

3 months ago