GitHubAPI | probot

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

GitHubAPI(options?: Options): GitHubAPI

- Defined in github/index.ts:14
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

Parameters
- Default value options: Options = {} as any
Returns GitHubAPI

Index

Modules

Github

Constructors

constructor

Properties

Methods

Constructors

constructor

new GitHubAPI(options?: Options): GitHubAPI

Inherited from Github.__constructor
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22775
Parameters
- Optional options: Options
Returns GitHubAPI

Properties

activity

activity: object

Type declaration

apps

apps: object

Type declaration

authorization

authorization: object

Type declaration

checks

checks: object

Type declaration

codesOfConduct

codesOfConduct: object

Type declaration

emojis

emojis: object

Type declaration

gists

gists: object

Type declaration

gitdata

gitdata: object

Type declaration

gitignore

gitignore: object

Type declaration

hook

hook: object

Type declaration

issues

issues: object

Type declaration

licenses

licenses: object

Type declaration

markdown

markdown: object

Type declaration

migrations

migrations: object

Type declaration

misc

misc: __type

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
    - - (response: Octokit.AnyResponse, done?: undefined | function): any
      - Parameters
        
        response: Octokit.AnyResponse
        
        Optional done: undefined | function
        
        Returns any
  Returns Promise<any[]>

projects

projects: object

Type declaration

pullRequests

pullRequests: object

Type declaration

query

query: function

Type declaration

- (query: string, variables?: Variables, headers?: Headers): Promise<any>
- Parameters
  - query: string
  - Optional variables: Variables
  - Optional headers: Headers
  Returns Promise<any>

rateLimit

rateLimit: object

Type declaration

reactions

reactions: object

Type declaration

repos

repos: object

Type declaration

request

request: function

Type declaration

- (RequestOptions: RequestOptions): Promise<Octokit.AnyResponse>
- Parameters
  - RequestOptions: RequestOptions
  Returns Promise<Octokit.AnyResponse>

search

search: object

Type declaration

teams

teams: object

Type declaration

users

users: object

Type declaration

Methods

authenticate

authenticate(auth: Auth): void

Inherited from Github.authenticate
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22777
Parameters
- auth: Auth
Returns void

getFirstPage

getFirstPage(link: Link, callback?: Callback<AnyResponse>): Promise<AnyResponse>
getFirstPage(link: Link, headers?: undefined | object, callback?: Callback<AnyResponse>): Promise<AnyResponse>

Inherited from Github.getFirstPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22813
Parameters
- link: Link
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>
Inherited from Github.getFirstPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22817
Parameters
- link: Link
- Optional headers: undefined | object
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>

getLastPage

getLastPage(link: Link, callback?: Callback<AnyResponse>): Promise<AnyResponse>
getLastPage(link: Link, headers?: undefined | object, callback?: Callback<AnyResponse>): Promise<AnyResponse>

Inherited from Github.getLastPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22803
Parameters
- link: Link
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>
Inherited from Github.getLastPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22807
Parameters
- link: Link
- Optional headers: undefined | object
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>

getNextPage

getNextPage(link: Link, callback?: Callback<AnyResponse>): Promise<AnyResponse>
getNextPage(link: Link, headers?: undefined | object, callback?: Callback<AnyResponse>): Promise<AnyResponse>

Inherited from Github.getNextPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22783
Parameters
- link: Link
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>
Inherited from Github.getNextPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22787
Parameters
- link: Link
- Optional headers: undefined | object
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>

getPreviousPage

getPreviousPage(link: Link, callback?: Callback<AnyResponse>): Promise<AnyResponse>
getPreviousPage(link: Link, headers?: undefined | object, callback?: Callback<AnyResponse>): Promise<AnyResponse>

Inherited from Github.getPreviousPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22793
Parameters
- link: Link
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>
Inherited from Github.getPreviousPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22797
Parameters
- link: Link
- Optional headers: undefined | object
- Optional callback: Callback<AnyResponse>
Returns Promise<AnyResponse>

hasFirstPage

hasFirstPage(link: Link): string | undefined

Inherited from Github.hasFirstPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22781
Parameters
- link: Link
Returns string | undefined

hasLastPage

hasLastPage(link: Link): string | undefined

Inherited from Github.hasLastPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22780
Parameters
- link: Link
Returns string | undefined

hasNextPage

hasNextPage(link: Link): string | undefined

Inherited from Github.hasNextPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22778
Parameters
- link: Link
Returns string | undefined

hasPreviousPage

hasPreviousPage(link: Link): string | undefined

Inherited from Github.hasPreviousPage
- Defined in /Users/tcbyrd/workspaces/github.com/probot/probot/node_modules/@octokit/rest/index.d.ts:22779
Parameters
- link: Link
Returns string | undefined

Generated using TypeDoc

Hierarchy

Callable

Parameters

Default value options: Options = {} as any

Returns GitHubAPI

Index

Modules

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: Options

Returns GitHubAPI

Properties

activity

Type declaration

apps

Type declaration

authorization

Type declaration

checks

Type declaration

codesOfConduct

Type declaration

emojis

Type declaration

gists

Type declaration

gitdata

Type declaration

gitignore

Type declaration

hook

Type declaration

issues

Type declaration

licenses

Type declaration

markdown

Type declaration

meta

Type declaration

migrations

Type declaration

misc

orgs

Type declaration

paginate

Type declaration

Parameters

res: Promise<Octokit.AnyResponse>

callback: function

Parameters

response: Octokit.AnyResponse

Optional done: undefined | function

Returns any

Returns Promise<any[]>

projects

Type declaration

pullRequests

Type declaration

query

Type declaration

Parameters

query: string

Optional variables: Variables

Optional headers: Headers

Returns Promise<any>

rateLimit

Type declaration

reactions

Type declaration

repos

Type declaration

request

Type declaration

Parameters

RequestOptions: RequestOptions