Class BaseAPI

This is the base class for all generated API classes.

Hierarchy

Constructors

Properties

configuration: Configuration = ...
middleware: Middleware[]

Methods

  • Create a shallow clone of this by constructing a new instance and then shallow cloning data members.

    Type Parameters

    Parameters

    • this: T

    Returns T

  • Parameters

    • context: RequestOpts
    • Optional initOverrides: RequestInit

    Returns {
        init: {
            body: any;
            cache?: RequestCache;
            credentials: RequestCredentials;
            headers: HTTPHeaders | [string, string][] | Headers;
            integrity?: string;
            keepalive?: boolean;
            method: string;
            mode?: RequestMode;
            redirect?: RequestRedirect;
            referrer?: string;
            referrerPolicy?: ReferrerPolicy;
            signal?: AbortSignal;
            window?: null;
        };
        url: string;
    }

    • init: {
          body: any;
          cache?: RequestCache;
          credentials: RequestCredentials;
          headers: HTTPHeaders | [string, string][] | Headers;
          integrity?: string;
          keepalive?: boolean;
          method: string;
          mode?: RequestMode;
          redirect?: RequestRedirect;
          referrer?: string;
          referrerPolicy?: ReferrerPolicy;
          signal?: AbortSignal;
          window?: null;
      }
      • body: any

        A BodyInit object or null to set request's body.

      • Optional cache?: RequestCache

        A string indicating how the request will interact with the browser's cache to set request's cache.

      • credentials: RequestCredentials

        A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

      • headers: HTTPHeaders | [string, string][] | Headers

        A Headers object, an object literal, or an array of two-item arrays to set request's headers.

      • Optional integrity?: string

        A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

      • Optional keepalive?: boolean

        A boolean to set request's keepalive.

      • method: string

        A string to set request's method.

      • Optional mode?: RequestMode

        A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

      • Optional redirect?: RequestRedirect

        A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

      • Optional referrer?: string

        A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

      • Optional referrerPolicy?: ReferrerPolicy

        A referrer policy to set request's referrerPolicy.

      • Optional signal?: AbortSignal

        An AbortSignal to set request's signal.

      • Optional window?: null

        Can only be null. Used to disassociate request from any Window.

    • url: string
  • Type Parameters

    Parameters

    Returns T