0

List Issues

by
Published today

List a repository's issues, filtered by state, labels, assignee or creator. GitHub returns pull requests here too; they carry a pull_request key. Paginate with page.

Script github Verified

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 1 hour ago
1
//native
2

3
/**
4
 * List Issues
5
 * List a repository's issues, filtered by state, labels, assignee or creator. GitHub returns pull requests here too; they carry a pull_request key. Paginate with page.
6
 */
7
export async function main(
8
  auth: RT.Github,
9
  owner: string,
10
  repo: string,
11
  state: "open" | "closed" | "all" | undefined,
12
  labels: string[] | undefined,
13
  assignee: string | undefined,
14
  creator: string | undefined,
15
  since: string | undefined,
16
  sort: "created" | "updated" | "comments" | undefined,
17
  direction: "asc" | "desc" | undefined,
18
  per_page: number = 30,
19
  page: number = 1
20
) {
21
  const url = new URL(`https://api.github.com/repos/${owner}/${repo}/issues`)
22
  const params = {
23
    state,
24
    labels: labels?.join(","),
25
    assignee,
26
    creator,
27
    since,
28
    sort,
29
    direction,
30
    per_page,
31
    page,
32
  }
33
  for (const [k, v] of Object.entries(params)) {
34
    if (v !== undefined && v !== "") url.searchParams.append(k, String(v))
35
  }
36

37
  const response = await fetch(url, {
38
    headers: {
39
      Authorization: `Bearer ${auth.token}`,
40
      Accept: "application/vnd.github+json",
41
      "X-GitHub-Api-Version": "2022-11-28",
42
    },
43
  })
44

45
  if (!response.ok) {
46
    throw new Error(`${response.status} ${await response.text()}`)
47
  }
48

49
  return await response.json()
50
}
51