centurion-ui
    Preparing search index...

    Interface djangoFetcherNamedParams

    Named Parameters for Django Fetcher.

    0.13.0

    interface djangoFetcherNamedParams {
        baseURL?: string;
        body?: BodyInit;
        getMetadata?: boolean;
        method?: "GET" | "OPTIONS" | "POST" | "PATCH";
        onlyMetadata?: boolean;
        signal?: AbortSignal;
        url: string;
    }

    Hierarchy (View Summary)

    Index
    baseURL?: string

    Backend base URL.

    This value is always to be supplied when a loader is calling. Additionally you should not supply this param a value as it is a requirement that all fetchers ignore it and obtain the backend.url via the BackendProvider from the nearest BackendLayout.

    body?: BodyInit

    Body to use for request.

    getMetadata?: boolean

    Additionally, fetch metadata

    method?: "GET" | "OPTIONS" | "POST" | "PATCH"

    HTTP method to use for the request.

    method = "OPTIONS"
    

    Note: Calling with method OPTIONS will force only obtaining the apiMetadata.

    onlyMetadata?: boolean

    Only fetch metadata

    signal?: AbortSignal

    Request signal.

    url: string

    URL for the request to be made against.