Interface ApiEndpointRequest<T>

interface ApiEndpointRequest<T> {
    body?: T;
    formData?: FormData;
    headers?: {
        [key: string]: string | number | boolean;
    };
    method: "GET" | "POST" | "PUT" | "DELETE";
    parseJson?: ((text, reviver?) => any);
    queryParams?: {
        [key: string]: string | number | boolean | undefined;
    };
    urlPath: string;
}

Type Parameters

  • T

Properties

body? formData? headers? method parseJson? queryParams? urlPath

Properties

Optional body

body?: T

The request body.

Optional formData

formData?: FormData

TODO: multi-part form support needs to be implemented

Optional headers

headers?: {
    [key: string]: string | number | boolean;
}

The headers.

Type declaration

  • [key: string]: string | number | boolean

method

method: "GET" | "POST" | "PUT" | "DELETE"

Optional parseJson

parseJson?: ((text, reviver?) => any)

A custom JSON parsing function

Type declaration

    • (text, reviver?): any

    • Parameters

      • text: string
      • Optional reviver: ((this, key, value) => any)
          • (this, key, value): any

          • Parameters

            • this: any
            • key: string
            • value: any

            Returns any

      Returns any

Optional queryParams

queryParams?: {
    [key: string]: string | number | boolean | undefined;
}

The query parameters.

Type declaration

  • [key: string]: string | number | boolean | undefined

urlPath

urlPath: string

The URL path of the API endpoint.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc