Endpoint | probot

Hierarchy

Endpoint

Callable

__call(Route: string, EndpointOptions?: Octokit.EndpointOptions): RequestOptions
__call(EndpointOptions: EndpointOptions): RequestOptions

- Defined in node_modules/@octokit/rest/index.d.ts:175
Parameters
- Route: string
- Optional EndpointOptions: Octokit.EndpointOptions
Returns RequestOptions
- Defined in node_modules/@octokit/rest/index.d.ts:179
Parameters
- EndpointOptions: EndpointOptions
Returns RequestOptions

Index

Properties

DEFAULTS

Methods

Properties

DEFAULTS

DEFAULTS: EndpointOptions

Current default options

Methods

defaults

defaults(EndpointOptions: EndpointOptions): Endpoint

- Defined in node_modules/@octokit/rest/index.d.ts:200
Merges existing defaults with passed options and returns new endpoint() method with new defaults

Parameters
- EndpointOptions: EndpointOptions
Returns Endpoint

merge

merge(Route: string, EndpointOptions?: Octokit.EndpointOptions): RequestOptions
merge(EndpointOptions: EndpointOptions): RequestOptions

- Defined in node_modules/@octokit/rest/index.d.ts:188
Get the defaulted endpoint options, but without parsing them into request options:

Parameters
- Route: string
- Optional EndpointOptions: Octokit.EndpointOptions
Returns RequestOptions
- Defined in node_modules/@octokit/rest/index.d.ts:192
Parameters
- EndpointOptions: EndpointOptions
Returns RequestOptions

parse

parse(EndpointOptions: EndpointOptions): RequestOptions

- Defined in node_modules/@octokit/rest/index.d.ts:196
Stateless method to turn endpoint options into request options. Calling endpoint(options) is the same as calling endpoint.parse(endpoint.merge(options)).

Parameters
- EndpointOptions: EndpointOptions
Returns RequestOptions

Generated using TypeDoc