@octokit/types
    Preparing search index...

    Interface EndpointInterface<D>

    interface EndpointInterface<D extends object = object> {
        defaults: <O extends RequestParameters = RequestParameters>(
            newDefaults: O,
        ) => EndpointInterface<D & O>;
        DEFAULTS: D & EndpointDefaults;
        merge: {
            <
                R extends string,
                P extends
                    RequestParameters = R extends keyof Endpoints
                    ? Endpoints[R<R>]["parameters"] & RequestParameters
                    : RequestParameters,
            >(
                route: (keyof Endpoints) | R,
                parameters?: P,
            ): D & (
                R extends keyof Endpoints
                    ? Endpoints[R<R>]["request"] & Endpoints[R<R>]["parameters"]
                    : EndpointDefaults
            ) & P;
            <P extends RequestParameters = RequestParameters>(
                options: P,
            ): EndpointDefaults & D & P;
            (): D & EndpointDefaults;
        };
        parse: <O extends EndpointDefaults = EndpointDefaults>(
            options: O,
        ) => RequestOptions & Pick<O, keyof RequestOptions>;
        <O extends RequestParameters = RequestParameters>(
            options: O & { method?: string } & (
                "url" extends keyof D ? { url?: string } : { url: string }
            ),
        ): RequestOptions & Pick<D & O, keyof RequestOptions>;
        <
            R extends string,
            P extends
                RequestParameters = R extends keyof Endpoints
                ? Endpoints[R<R>]["parameters"] & RequestParameters
                : RequestParameters,
        >(
            route: R | (keyof Endpoints),
            parameters?: P,
        ): (
            R extends keyof Endpoints ? Endpoints[R<R>]["request"] : RequestOptions
        ) & Pick<P, keyof RequestOptions>;
    }

    Type Parameters

    • D extends object = object
    Index

    Properties

    defaults DEFAULTS merge parse

    Properties

    defaults: <O extends RequestParameters = RequestParameters>(
        newDefaults: O,
    ) => EndpointInterface<D & O>

    Returns a new endpoint interface with new defaults

    DEFAULTS: D & EndpointDefaults

    Object with current default route and parameters

    merge: {
        <
            R extends string,
            P extends
                RequestParameters = R extends keyof Endpoints
                ? Endpoints[R<R>]["parameters"] & RequestParameters
                : RequestParameters,
        >(
            route: (keyof Endpoints) | R,
            parameters?: P,
        ): D & (
            R extends keyof Endpoints
                ? Endpoints[R<R>]["request"] & Endpoints[R<R>]["parameters"]
                : EndpointDefaults
        ) & P;
        <P extends RequestParameters = RequestParameters>(
            options: P,
        ): EndpointDefaults & D & P;
        (): D & EndpointDefaults;
    }

    Type declaration

    parse: <O extends EndpointDefaults = EndpointDefaults>(
        options: O,
    ) => RequestOptions & Pick<O, keyof RequestOptions>

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

    Type declaration

    Settings

    Member Visibility

    On This Page

    Properties