Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Endpoint

Callable

  • Parameters

    • Route: string
    • Optional EndpointOptions: Octokit.EndpointOptions

    Returns RequestOptions

  • Parameters

    Returns RequestOptions

Index

Properties

Methods

Properties

DEFAULTS

DEFAULTS: EndpointOptions

Current default options

Methods

defaults

  • Merges existing defaults with passed options and returns new endpoint() method with new defaults

    Parameters

    Returns Endpoint

merge

  • Get the defaulted endpoint options, but without parsing them into request options:

    Parameters

    • Route: string
    • Optional EndpointOptions: Octokit.EndpointOptions

    Returns RequestOptions

  • Parameters

    Returns RequestOptions

parse

  • Stateless method to turn endpoint options into request options. Calling endpoint(options) is the same as calling endpoint.parse(endpoint.merge(options)).

    Parameters

    Returns RequestOptions

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • 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