@octokit/types
    Preparing search index...

    Interface EndpointOptions

    Parameters that can be passed into request(route, parameters) or endpoint(route, parameters) methods

    interface EndpointOptions {
        baseUrl?: string;
        headers?: RequestHeaders;
        mediaType?: { format?: string; previews?: string[] };
        method: RequestMethod;
        operationName?: string;
        query?: string;
        request?: RequestRequestOptions;
        url: string;
        [parameter: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [parameter: string]: unknown

      Any additional parameter will be passed as follows

      1. URL parameter if ':parameter' or {parameter} is part of url
      2. Query parameter if method is 'GET' or 'HEAD'
      3. Request body if parameter is 'data'
      4. JSON in the request body in the form of body[parameter] unless parameter key is 'data'
    Index

    Properties

    baseUrl? headers? mediaType? method operationName? query? request? url

    Properties

    baseUrl?: string

    Base URL to be used when a relative URL is passed, such as /orgs/{org}. If baseUrl is https://enterprise.acme-inc.com/api/v3, then the request will be sent to https://enterprise.acme-inc.com/api/v3/orgs/{org}.

    headers?: RequestHeaders

    HTTP headers. Use lowercase keys.

    mediaType?: { format?: string; previews?: string[] }

    Media type options, see Developer Guide

    Type declaration

    • Optionalformat?: string

      json by default. Can be raw, text, html, full, diff, patch, sha, base64. Depending on endpoint

    • Optionalpreviews?: string[]

      Custom media type names of API Previews without the -preview suffix. Example for single preview: ['squirrel-girl']. Example for multiple previews: ['squirrel-girl', 'mister-fantastic'].

    method: RequestMethod
    operationName?: string

    The name of the operation to execute. Required only if multiple operations are present in the query document.

    query?: string

    The GraphQL query string to be sent in the request. This is required and must contain a valid GraphQL document.

    request?: RequestRequestOptions

    Pass custom meta information for the request. The request object will be returned as is.

    url: string

    Settings

    Member Visibility

    On This Page

    Properties