octokit-plugin-get-timeline-assignees-logins
v1.0.0
Published
Retrieve an array of GitHub user logins that have been assigned to a given issue or pull request at some point
Downloads
1,202
Readme
octokit-plugin-get-timeline-assignees-logins
Retrieve an array of GitHub user logins that have been assigned to a given issue or pull request at some point
usage
Browsers
Load octokit-plugin-get-timeline-assignees-logins
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 { getTimelineAssigneesLogins } from "https://cdn.skypack.dev/octokit-plugin-get-timeline-assignees-logins";
</script>
Node
Install with npm install @octokit/core octokit-plugin-get-timeline-assignees-logins
. Optionally replace @octokit/core
with a compatible module
const { Octokit } = require("@octokit/core");
const {
getTimelineAssigneesLogins,
} = require("octokit-plugin-get-timeline-assignees-logins");
const MyOctokit = Octokit.plugin(getTimelineAssigneesLogins);
const octokit = new MyOctokit({ auth: "secret123" });
const logins = await octokit.getTimelineAssigneesLogins({
owner: "gr2m",
repo: "octokit-plugin-get-timeline-assignees-logins",
number: 1,
});
// `logins` is `["gr2m", "gr2m-test"]`
If you want to utilize this plugin with an existing octokit
instance, use composeGetTimelineAssigneesLogins
instead
const logins = await composeGetTimelineAssigneesLogins(octokit, {
owner: "gr2m",
repo: "octokit-plugin-get-timeline-assignees-logins",
number: 1,
});
Note: This plugin only retrieves the first 100 assign events. If you need to retrieve more than 100 assign events, please file an issue. I'm curious to learn about your use case. Retrieving more than 100 is a tad complicated, but not impossible.
Options
Contributing
See CONTRIBUTING.md