octokit-plugin-get-open-repository-issues-count-by-assignees
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

octokit-plugin-get-open-repository-issues-count-by-assignees

Get the number of open repository issues assigned to a list of users

@latest Build Status

usage

Browsers

Load octokit-plugin-get-open-repository-issues-count-by-assignees and @octokit/core (or core-compatible module) directly from cdn.skypack.dev

<script type="module">
  import { Octokit } from "https://cdn.skypack.dev/@octokit/core";
  import { getOpenRepositoryIssuesCountByAssignees } from "https://cdn.skypack.dev/octokit-plugin-get-open-repository-issues-count-by-assignees";
</script>

Node

Install with npm install @octokit/core octokit-plugin-get-open-repository-issues-count-by-assignees. Optionally replace @octokit/core with a compatible module

const { Octokit } = require("@octokit/core");
const {
  getOpenRepositoryIssuesCountByAssignees,
} = require("octokit-plugin-get-open-repository-issues-count-by-assignees");
const MyOctokit = Octokit.plugin(getOpenRepositoryIssuesCountByAssignees);
const octokit = new MyOctokit({ auth: "secret123" });

const result = await octokit.getOpenRepositoryIssuesCountByAssignees({
  owner: "gr2m",
  repo: "octokit-plugin-get-open-repository-issues-count-by-assignees",
  assignees: ["user1", "user2", "user3"],
});
// `result` is an object with keys being the user logins and the values being the
// number of open issues assigned to that user. For example:
// { user1: 0, user2: 3, user3: 1 }

Options

name type description
owner string Required. Repository owner login
repo string Required. Repository name
assignees string[] Required. Array of GitHub user account logins

Contributing

See CONTRIBUTING.md

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i octokit-plugin-get-open-repository-issues-count-by-assignees

Weekly Downloads

556

Version

1.0.1

License

MIT

Unpacked Size

20.4 kB

Total Files

13

Last publish

Collaborators

  • gr2m