Options
All
  • Public
  • Public/Protected
  • All
Menu

the @octokit/rest Node.js module, which wraps the GitHub API and allows you to do almost anything programmatically that you can do through a web browser.

see

https://github.com/octokit/rest.js

Hierarchy

  • Github
    • GitHubAPI

Callable

Index

Constructors

constructor

  • Parameters

    Returns GitHubAPI

Properties

activity

activity: object

Type declaration

apps

apps: object

Type declaration

authorization

authorization: object

Type declaration

checks

checks: object

Type declaration

gists

gists: object

Type declaration

gitdata

gitdata: object

Type declaration

hook

hook: object

Type declaration

issues

issues: object

Type declaration

migrations

migrations: object

Type declaration

misc

misc: object

Type declaration

orgs

orgs: object

Type declaration

paginate

paginate: function

Type declaration

    • (res: Promise<Octokit.AnyResponse>, callback: function): Promise<any[]>
    • Parameters

      • res: Promise<Octokit.AnyResponse>
      • callback: function
          • (results: Octokit.AnyResponse): void
          • Parameters

            • results: Octokit.AnyResponse

            Returns void

      Returns Promise<any[]>

projects

projects: object

Type declaration

pullRequests

pullRequests: object

Type declaration

query

query: function

Type declaration

reactions

reactions: object

Type declaration

repos

repos: object

Type declaration

request

request: function

Type declaration

    • Parameters

      Returns Promise<Octokit.AnyResponse>

search

search: object

Type declaration

users

users: object

Type declaration

Methods

authenticate

  • authenticate(auth: Auth): void
  • Parameters

    Returns void

getFirstPage

  • Parameters

    Returns Promise<AnyResponse>

  • Parameters

    Returns Promise<AnyResponse>

getLastPage

  • Parameters

    Returns Promise<AnyResponse>

  • Parameters

    Returns Promise<AnyResponse>

getNextPage

  • Parameters

    Returns Promise<AnyResponse>

  • Parameters

    Returns Promise<AnyResponse>

getPreviousPage

  • Parameters

    Returns Promise<AnyResponse>

  • Parameters

    Returns Promise<AnyResponse>

hasFirstPage

  • hasFirstPage(link: Link): string | undefined
  • Parameters

    Returns string | undefined

hasLastPage

  • hasLastPage(link: Link): string | undefined
  • Parameters

    Returns string | undefined

hasNextPage

  • hasNextPage(link: Link): string | undefined
  • Parameters

    Returns string | undefined

hasPreviousPage

  • hasPreviousPage(link: Link): string | undefined
  • Parameters

    Returns string | undefined

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc