@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    Class ContractsClient

    The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

    Hierarchy (View Summary)

    Index
    constructor
    api _client _endpoints
    streamEndpoint fetchAllEndpoint withMetadata withSafeMode getCharacterContracts getCharacterContractBids getCharacterContractItems getPublicContracts getPublicContractBids getPublicContractItems getCorporationContracts getCorporationContractBids getCorporationContractItems fetchAllPublicContracts fetchAllPublicContractBids fetchAllPublicContractItems fetchAllCharacterContracts fetchAllCorporationContracts streamPublicContracts streamPublicContractBids streamPublicContractItems streamCharacterContracts streamCorporationContracts
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getCharacterContracts: {
            path: "characters/{characterId}/contracts";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        contract_id: ZodNumber;
                        issuer_id: ZodNumber;
                        issuer_corporation_id: ZodNumber;
                        assignee_id: ZodNumber;
                        acceptor_id: ZodNumber;
                        start_location_id: ZodOptional<ZodNumber>;
                        end_location_id: ZodOptional<ZodNumber>;
                        type: ZodType<
                            | string & {}
                            | "unknown"
                            | "item_exchange"
                            | "auction"
                            | "courier"
                            | "loan",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "unknown"
                                | "item_exchange"
                                | "auction"
                                | "courier"
                                | "loan",
                                unknown,
                            >,
                        >;
                        status: ZodType<
                            | string & {}
                            | "cancelled"
                            | "outstanding"
                            | "in_progress"
                            | "finished_issuer"
                            | "finished_contractor"
                            | "finished"
                            | "rejected"
                            | "failed"
                            | "deleted"
                            | "reversed",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "cancelled"
                                | "outstanding"
                                | "in_progress"
                                | "finished_issuer"
                                | "finished_contractor"
                                | "finished"
                                | "rejected"
                                | "failed"
                                | "deleted"
                                | "reversed",
                                unknown,
                            >,
                        >;
                        title: ZodOptional<ZodString>;
                        for_corporation: ZodBoolean;
                        availability: ZodType<
                            string & {}
                            | "corporation"
                            | "alliance"
                            | "public"
                            | "personal",
                            unknown,
                            $ZodTypeInternals<
                                string & {}
                                | "corporation"
                                | "alliance"
                                | "public"
                                | "personal",
                                unknown,
                            >,
                        >;
                        date_issued: ZodString;
                        date_expired: ZodString;
                        date_accepted: ZodOptional<ZodString>;
                        date_completed: ZodOptional<ZodString>;
                        days_to_complete: ZodOptional<ZodNumber>;
                        price: ZodOptional<ZodNumber>;
                        reward: ZodOptional<ZodNumber>;
                        collateral: ZodOptional<ZodNumber>;
                        buyout: ZodOptional<ZodNumber>;
                        volume: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getCharacterContractBids: {
            path: "characters/{characterId}/contracts/{contractId}/bids";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId", "contractId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        bid_id: ZodNumber;
                        bidder_id: ZodNumber;
                        date_bid: ZodString;
                        amount: ZodNumber;
                    },
                    $loose,
                >,
            >;
        };
        getCharacterContractItems: {
            path: "characters/{characterId}/contracts/{contractId}/items";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId", "contractId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        record_id: ZodNumber;
                        type_id: ZodNumber;
                        quantity: ZodNumber;
                        raw_quantity: ZodOptional<ZodNumber>;
                        is_singleton: ZodBoolean;
                        is_included: ZodBoolean;
                    },
                    $loose,
                >,
            >;
        };
        getCorporationContracts: {
            path: "corporations/{corporationId}/contracts";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        contract_id: ZodNumber;
                        issuer_id: ZodNumber;
                        issuer_corporation_id: ZodNumber;
                        assignee_id: ZodNumber;
                        acceptor_id: ZodNumber;
                        start_location_id: ZodOptional<ZodNumber>;
                        end_location_id: ZodOptional<ZodNumber>;
                        type: ZodType<
                            | string & {}
                            | "unknown"
                            | "item_exchange"
                            | "auction"
                            | "courier"
                            | "loan",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "unknown"
                                | "item_exchange"
                                | "auction"
                                | "courier"
                                | "loan",
                                unknown,
                            >,
                        >;
                        status: ZodType<
                            | string & {}
                            | "cancelled"
                            | "outstanding"
                            | "in_progress"
                            | "finished_issuer"
                            | "finished_contractor"
                            | "finished"
                            | "rejected"
                            | "failed"
                            | "deleted"
                            | "reversed",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "cancelled"
                                | "outstanding"
                                | "in_progress"
                                | "finished_issuer"
                                | "finished_contractor"
                                | "finished"
                                | "rejected"
                                | "failed"
                                | "deleted"
                                | "reversed",
                                unknown,
                            >,
                        >;
                        title: ZodOptional<ZodString>;
                        for_corporation: ZodBoolean;
                        availability: ZodType<
                            string & {}
                            | "corporation"
                            | "alliance"
                            | "public"
                            | "personal",
                            unknown,
                            $ZodTypeInternals<
                                string & {}
                                | "corporation"
                                | "alliance"
                                | "public"
                                | "personal",
                                unknown,
                            >,
                        >;
                        date_issued: ZodString;
                        date_expired: ZodString;
                        date_accepted: ZodOptional<ZodString>;
                        date_completed: ZodOptional<ZodString>;
                        days_to_complete: ZodOptional<ZodNumber>;
                        price: ZodOptional<ZodNumber>;
                        reward: ZodOptional<ZodNumber>;
                        collateral: ZodOptional<ZodNumber>;
                        buyout: ZodOptional<ZodNumber>;
                        volume: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getCorporationContractBids: {
            path: "corporations/{corporationId}/contracts/{contractId}/bids";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId", "contractId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        bid_id: ZodNumber;
                        bidder_id: ZodNumber;
                        date_bid: ZodString;
                        amount: ZodNumber;
                    },
                    $loose,
                >,
            >;
        };
        getCorporationContractItems: {
            path: "corporations/{corporationId}/contracts/{contractId}/items";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId", "contractId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        record_id: ZodNumber;
                        type_id: ZodNumber;
                        quantity: ZodNumber;
                        raw_quantity: ZodOptional<ZodNumber>;
                        is_singleton: ZodBoolean;
                        is_included: ZodBoolean;
                    },
                    $loose,
                >,
            >;
        };
        getPublicContracts: {
            path: "contracts/public/{regionId}";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["regionId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        contract_id: ZodNumber;
                        issuer_id: ZodNumber;
                        issuer_corporation_id: ZodNumber;
                        start_location_id: ZodOptional<ZodNumber>;
                        end_location_id: ZodOptional<ZodNumber>;
                        type: ZodType<
                            | string & {}
                            | "unknown"
                            | "item_exchange"
                            | "auction"
                            | "courier"
                            | "loan",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "unknown"
                                | "item_exchange"
                                | "auction"
                                | "courier"
                                | "loan",
                                unknown,
                            >,
                        >;
                        title: ZodOptional<ZodString>;
                        for_corporation: ZodOptional<ZodBoolean>;
                        date_issued: ZodString;
                        date_expired: ZodString;
                        days_to_complete: ZodOptional<ZodNumber>;
                        price: ZodOptional<ZodNumber>;
                        reward: ZodOptional<ZodNumber>;
                        collateral: ZodOptional<ZodNumber>;
                        buyout: ZodOptional<ZodNumber>;
                        volume: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
        };
        getPublicContractBids: {
            path: "contracts/public/bids/{contractId}";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["contractId"];
            responseSchema: ZodArray<
                ZodObject<
                    { bid_id: ZodNumber; date_bid: ZodString; amount: ZodNumber },
                    $loose,
                >,
            >;
            emptyWhenNoContent: true;
        };
        getPublicContractItems: {
            path: "contracts/public/items/{contractId}";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["contractId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        record_id: ZodNumber;
                        type_id: ZodNumber;
                        quantity: ZodNumber;
                        is_included: ZodBoolean;
                        item_id: ZodOptional<ZodNumber>;
                        is_blueprint_copy: ZodOptional<ZodBoolean>;
                        material_efficiency: ZodOptional<ZodNumber>;
                        time_efficiency: ZodOptional<ZodNumber>;
                        runs: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
            emptyWhenNoContent: true;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getCharacterContracts"
            | "getCharacterContractBids"
            | "getCharacterContractItems"
            | "getCorporationContracts"
            | "getCorporationContractBids"
            | "getCorporationContractItems"
            | "getPublicContracts"
            | "getPublicContractBids"
            | "getPublicContractItems"
      • ...args: unknown[]

      Returns AsyncGenerator<PageResult<R>, void, undefined>

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getCharacterContracts"
            | "getCharacterContractBids"
            | "getCharacterContractItems"
            | "getCorporationContracts"
            | "getCorporationContractBids"
            | "getCorporationContractItems"
            | "getPublicContracts"
            | "getPublicContractBids"
            | "getPublicContractItems"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieve contracts issued by or assigned to a character.

      Parameters

      • characterId: number

        The ID of the character whose contracts to retrieve

      Returns Promise<
          {
              contract_id: number;
              issuer_id: number;
              issuer_corporation_id: number;
              assignee_id: number;
              acceptor_id: number;
              start_location_id?: number;
              end_location_id?: number;
              type: | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
              status: | string & {}
              | "cancelled"
              | "outstanding"
              | "in_progress"
              | "finished_issuer"
              | "finished_contractor"
              | "finished"
              | "rejected"
              | "failed"
              | "deleted"
              | "reversed";
              title?: string;
              for_corporation: boolean;
              availability: | string & {}
              | "corporation"
              | "alliance"
              | "public"
              | "personal";
              date_issued: string;
              date_expired: string;
              date_accepted?: string;
              date_completed?: string;
              days_to_complete?: number;
              price?: number;
              reward?: number;
              collateral?: number;
              buyout?: number;
              volume?: number;
              [key: string]: unknown;
          }[],
      >

      A list of contracts with type, status, and pricing information

      Authentication

    • Retrieve bids placed on an auction contract owned by a character.

      Parameters

      • characterId: number

        The ID of the character who owns the contract

      • contractId: number

        The ID of the contract whose bids to retrieve

      Returns Promise<
          {
              bid_id: number;
              bidder_id: number;
              date_bid: string;
              amount: number;
              [key: string]: unknown;
          }[],
      >

      A list of bids with bidder, amount, and timestamp

      Authentication

    • Retrieve the items included in a contract owned by a character.

      Parameters

      • characterId: number

        The ID of the character who owns the contract

      • contractId: number

        The ID of the contract whose items to retrieve

      Returns Promise<
          {
              record_id: number;
              type_id: number;
              quantity: number;
              raw_quantity?: number;
              is_singleton: boolean;
              is_included: boolean;
              [key: string]: unknown;
          }[],
      >

      A list of items in the contract with type, quantity, and included/excluded status

      Authentication

    • Retrieve publicly available contracts in a specific region.

      Parameters

      • regionId: number

        The ID of the region whose public contracts to retrieve

      Returns Promise<
          {
              contract_id: number;
              issuer_id: number;
              issuer_corporation_id: number;
              start_location_id?: number;
              end_location_id?: number;
              type: | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
              title?: string;
              for_corporation?: boolean;
              date_issued: string;
              date_expired: string;
              days_to_complete?: number;
              price?: number;
              reward?: number;
              collateral?: number;
              buyout?: number;
              volume?: number;
              [key: string]: unknown;
          }[],
      >

      A list of public contracts in the region. ESI sends no status or availability on these: every listed contract is public and outstanding.

    • Retrieve bids placed on a public auction contract.

      Parameters

      • contractId: number

        The ID of the public contract whose bids to retrieve

      Returns Promise<
          {
              bid_id: number;
              date_bid: string;
              amount: number;
              [key: string]: unknown;
          }[],
      >

      A list of bids with amount and timestamp. ESI does not name the bidder on a public contract.

    • Retrieve the items included in a public contract.

      Parameters

      • contractId: number

        The ID of the public contract whose items to retrieve

      Returns Promise<
          {
              record_id: number;
              type_id: number;
              quantity: number;
              is_included: boolean;
              item_id?: number;
              is_blueprint_copy?: boolean;
              material_efficiency?: number;
              time_efficiency?: number;
              runs?: number;
              [key: string]: unknown;
          }[],
      >

      A list of items in the contract with type, quantity, and included/excluded status; blueprint lines also carry item ID, efficiencies and runs

    • Retrieve contracts issued by or assigned to a corporation.

      Parameters

      • corporationId: number

        The ID of the corporation whose contracts to retrieve

      Returns Promise<
          {
              contract_id: number;
              issuer_id: number;
              issuer_corporation_id: number;
              assignee_id: number;
              acceptor_id: number;
              start_location_id?: number;
              end_location_id?: number;
              type: | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
              status: | string & {}
              | "cancelled"
              | "outstanding"
              | "in_progress"
              | "finished_issuer"
              | "finished_contractor"
              | "finished"
              | "rejected"
              | "failed"
              | "deleted"
              | "reversed";
              title?: string;
              for_corporation: boolean;
              availability: | string & {}
              | "corporation"
              | "alliance"
              | "public"
              | "personal";
              date_issued: string;
              date_expired: string;
              date_accepted?: string;
              date_completed?: string;
              days_to_complete?: number;
              price?: number;
              reward?: number;
              collateral?: number;
              buyout?: number;
              volume?: number;
              [key: string]: unknown;
          }[],
      >

      A list of contracts with type, status, and pricing information

      Authentication

    • Retrieve bids placed on an auction contract owned by a corporation.

      Parameters

      • corporationId: number

        The ID of the corporation that owns the contract

      • contractId: number

        The ID of the contract whose bids to retrieve

      Returns Promise<
          {
              bid_id: number;
              bidder_id: number;
              date_bid: string;
              amount: number;
              [key: string]: unknown;
          }[],
      >

      A list of bids with bidder, amount, and timestamp

      Authentication

    • Retrieve the items included in a contract owned by a corporation.

      Parameters

      • corporationId: number

        The ID of the corporation that owns the contract

      • contractId: number

        The ID of the contract whose items to retrieve

      Returns Promise<
          {
              record_id: number;
              type_id: number;
              quantity: number;
              raw_quantity?: number;
              is_singleton: boolean;
              is_included: boolean;
              [key: string]: unknown;
          }[],
      >

      A list of items in the contract with type, quantity, and included/excluded status

      Authentication

    • Parameters

      • regionId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              contract_id: number;
              issuer_id: number;
              issuer_corporation_id: number;
              start_location_id?: number;
              end_location_id?: number;
              type: | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
              title?: string;
              for_corporation?: boolean;
              date_issued: string;
              date_expired: string;
              days_to_complete?: number;
              price?: number;
              reward?: number;
              collateral?: number;
              buyout?: number;
              volume?: number;
              [key: string]: unknown;
          }[],
      >

    • Collect every page of bids on a public auction contract.

      Parameters

      • contractId: number

        The ID of the public contract whose bids to collect

      • Optionalconcurrency: number

        How many pages to request at once (default 8)

      Returns Promise<
          {
              bid_id: number;
              date_bid: string;
              amount: number;
              [key: string]: unknown;
          }[],
      >

      Every bid on the contract; an empty list when ESI answers with no content because the contract expired or was accepted

    • Collect every page of items in a public contract.

      Parameters

      • contractId: number

        The ID of the public contract whose items to collect

      • Optionalconcurrency: number

        How many pages to request at once (default 8)

      Returns Promise<
          {
              record_id: number;
              type_id: number;
              quantity: number;
              is_included: boolean;
              item_id?: number;
              is_blueprint_copy?: boolean;
              material_efficiency?: number;
              time_efficiency?: number;
              runs?: number;
              [key: string]: unknown;
          }[],
      >

      Every item line in the contract; an empty list when ESI answers with no content because the contract expired or was accepted

    • Parameters

      • characterId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              contract_id: number;
              issuer_id: number;
              issuer_corporation_id: number;
              assignee_id: number;
              acceptor_id: number;
              start_location_id?: number;
              end_location_id?: number;
              type: | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
              status: | string & {}
              | "cancelled"
              | "outstanding"
              | "in_progress"
              | "finished_issuer"
              | "finished_contractor"
              | "finished"
              | "rejected"
              | "failed"
              | "deleted"
              | "reversed";
              title?: string;
              for_corporation: boolean;
              availability: | string & {}
              | "corporation"
              | "alliance"
              | "public"
              | "personal";
              date_issued: string;
              date_expired: string;
              date_accepted?: string;
              date_completed?: string;
              days_to_complete?: number;
              price?: number;
              reward?: number;
              collateral?: number;
              buyout?: number;
              volume?: number;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • corporationId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              contract_id: number;
              issuer_id: number;
              issuer_corporation_id: number;
              assignee_id: number;
              acceptor_id: number;
              start_location_id?: number;
              end_location_id?: number;
              type: | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
              status: | string & {}
              | "cancelled"
              | "outstanding"
              | "in_progress"
              | "finished_issuer"
              | "finished_contractor"
              | "finished"
              | "rejected"
              | "failed"
              | "deleted"
              | "reversed";
              title?: string;
              for_corporation: boolean;
              availability: | string & {}
              | "corporation"
              | "alliance"
              | "public"
              | "personal";
              date_issued: string;
              date_expired: string;
              date_accepted?: string;
              date_completed?: string;
              days_to_complete?: number;
              price?: number;
              reward?: number;
              collateral?: number;
              buyout?: number;
              volume?: number;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • regionId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  contract_id: number;
                  issuer_id: number;
                  issuer_corporation_id: number;
                  start_location_id?: number;
                  end_location_id?: number;
                  type: | string & {}
                  | "unknown"
                  | "item_exchange"
                  | "auction"
                  | "courier"
                  | "loan";
                  title?: string;
                  for_corporation?: boolean;
                  date_issued: string;
                  date_expired: string;
                  days_to_complete?: number;
                  price?: number;
                  reward?: number;
                  collateral?: number;
                  buyout?: number;
                  volume?: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Stream the bids on a public auction contract one page at a time.

      Parameters

      • contractId: number

        The ID of the public contract whose bids to stream

      Returns AsyncGenerator<
          PageResult<
              {
                  bid_id: number;
                  date_bid: string;
                  amount: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

      The pages of bids; one empty page when ESI answers with no content because the contract expired or was accepted

    • Stream the items in a public contract one page at a time.

      Parameters

      • contractId: number

        The ID of the public contract whose items to stream

      Returns AsyncGenerator<
          PageResult<
              {
                  record_id: number;
                  type_id: number;
                  quantity: number;
                  is_included: boolean;
                  item_id?: number;
                  is_blueprint_copy?: boolean;
                  material_efficiency?: number;
                  time_efficiency?: number;
                  runs?: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

      The pages of item lines; one empty page when ESI answers with no content because the contract expired or was accepted

    • Parameters

      • characterId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  contract_id: number;
                  issuer_id: number;
                  issuer_corporation_id: number;
                  assignee_id: number;
                  acceptor_id: number;
                  start_location_id?: number;
                  end_location_id?: number;
                  type: | string & {}
                  | "unknown"
                  | "item_exchange"
                  | "auction"
                  | "courier"
                  | "loan";
                  status: | string & {}
                  | "cancelled"
                  | "outstanding"
                  | "in_progress"
                  | "finished_issuer"
                  | "finished_contractor"
                  | "finished"
                  | "rejected"
                  | "failed"
                  | "deleted"
                  | "reversed";
                  title?: string;
                  for_corporation: boolean;
                  availability: | string & {}
                  | "corporation"
                  | "alliance"
                  | "public"
                  | "personal";
                  date_issued: string;
                  date_expired: string;
                  date_accepted?: string;
                  date_completed?: string;
                  days_to_complete?: number;
                  price?: number;
                  reward?: number;
                  collateral?: number;
                  buyout?: number;
                  volume?: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • corporationId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  contract_id: number;
                  issuer_id: number;
                  issuer_corporation_id: number;
                  assignee_id: number;
                  acceptor_id: number;
                  start_location_id?: number;
                  end_location_id?: number;
                  type: | string & {}
                  | "unknown"
                  | "item_exchange"
                  | "auction"
                  | "courier"
                  | "loan";
                  status: | string & {}
                  | "cancelled"
                  | "outstanding"
                  | "in_progress"
                  | "finished_issuer"
                  | "finished_contractor"
                  | "finished"
                  | "rejected"
                  | "failed"
                  | "deleted"
                  | "reversed";
                  title?: string;
                  for_corporation: boolean;
                  availability: | string & {}
                  | "corporation"
                  | "alliance"
                  | "public"
                  | "personal";
                  date_issued: string;
                  date_expired: string;
                  date_accepted?: string;
                  date_completed?: string;
                  days_to_complete?: number;
                  price?: number;
                  reward?: number;
                  collateral?: number;
                  buyout?: number;
                  volume?: number;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods