• Build and execute a specific REST query.

    Type Parameters

    • TRequest extends IRouteRequestInterface
    • TParams extends IRouteParamsInterface
    • TResponse extends IRouteResponseInterface

    Parameters

    • __namedParameters: {
          allowBatchRequest?: boolean | Pick<{
              restNamespace: string;
              restNonce?: string;
              restPathObfuscateOffset?: string;
              restQuery?: object;
              restRecreateNonceEndpoint?: string;
              restRoot: string;
          } & {
              onQueueItemFinished?: ((state) => void);
              signal?: AbortSignal;
              waitForPromise?: Promise<void>;
          }, "onQueueItemFinished" | "waitForPromise">;
          multipart?: boolean | MultiPartOptions;
          params?: TParams;
          replayReason?: ReplayReason;
          request?: TRequest;
          sendReferer?: boolean;
          sendRestNonce?: boolean;
          settings?: Partial<{
              body: ReadableStream<Uint8Array>;
              bodyUsed: boolean;
              cache: RequestCache;
              credentials: RequestCredentials;
              destination: RequestDestination;
              headers: Headers;
              integrity: string;
              keepalive: boolean;
              method: string;
              mode: RequestMode;
              redirect: RequestRedirect;
              referrer: string;
              referrerPolicy: ReferrerPolicy;
              signal: AbortSignal;
              url: string;
              arrayBuffer(): Promise<ArrayBuffer>;
              blob(): Promise<Blob>;
              clone(): Request;
              formData(): Promise<FormData>;
              json(): Promise<any>;
              text(): Promise<string>;
          }>;
      } & UrlBuilderArgs

    Returns Promise<TResponse>

    Result of REST API

    See

    urlBuilder

    Throws