NextGIS Frontend
    Preparing search index...

    Interface RouteMethods<N>

    interface RouteMethods<N extends RouteName> {
        delete: HasRequiredKeys<RouteQuery<N, "delete">> extends true
            ? <T = RouteResp<N, "delete">>(
                options: DeleteRequestOptions<RouteQuery<N, "delete">, "json">,
            ) => Promise<T>
            : <T = RouteResp<N, "delete">>(
                options?: DeleteRequestOptions<RouteQuery<N, "delete">, "json">,
            ) => Promise<T>;
        get: HasRequiredKeys<RouteQuery<N, "get">> extends true
            ? <
                T = RouteResp<N, "get">,
                RT extends ResponseType = "json",
                B extends boolean = false,
            >(
                options: GetRequestOptions<RouteQuery<N, "get">, RT, B>,
            ) => Promise<ToReturn<T, RT, B>>
            : <
                T = RouteResp<N, "get">,
                B extends boolean = false,
                RT extends ResponseType = "json",
            >(
                options?: GetRequestOptions<RouteQuery<N, "get">, RT, B>,
            ) => Promise<ToReturn<T, RT, B>>;
        patch: <T = RouteResp<N, "patch">, RT extends ResponseType = "json">(
            options: PatchRequestOptions<RouteQuery<N, "patch">, RT, "json">,
        ) => Promise<RT extends "blob" ? Blob : T>;
        post: <T = RouteResp<N, "post">, RT extends ResponseType = "json">(
            options: PostRequestOptions<
                RouteQuery<N, "post">,
                RouteBody<N, "post">,
                RT,
            >,
        ) => Promise<RT extends "blob" ? Blob : T>;
        put: <T = RouteResp<N, "put">, RT extends ResponseType = "json">(
            options: PutRequestOptions<
                RouteQuery<N, "put">,
                RouteBody<N, "put">,
                RT,
            >,
        ) => Promise<RT extends "blob" ? Blob : T>;
        url: HasRequiredKeys<RouteQuery<N, "get">> extends true
            ? (
                options: Pick<
                    GetRequestOptions<RouteQuery<N, "get">, "json", false>,
                    "query",
                >,
            ) => Promise<string>
            : (
                options?: Pick<
                    GetRequestOptions<RouteQuery<N, "get">, "json", false>,
                    "query",
                >,
            ) => Promise<string>;
    }

    Type Parameters

    Index

    Properties

    Properties

    delete: HasRequiredKeys<RouteQuery<N, "delete">> extends true
        ? <T = RouteResp<N, "delete">>(
            options: DeleteRequestOptions<RouteQuery<N, "delete">, "json">,
        ) => Promise<T>
        : <T = RouteResp<N, "delete">>(
            options?: DeleteRequestOptions<RouteQuery<N, "delete">, "json">,
        ) => Promise<T>
    get: HasRequiredKeys<RouteQuery<N, "get">> extends true
        ? <
            T = RouteResp<N, "get">,
            RT extends ResponseType = "json",
            B extends boolean = false,
        >(
            options: GetRequestOptions<RouteQuery<N, "get">, RT, B>,
        ) => Promise<ToReturn<T, RT, B>>
        : <
            T = RouteResp<N, "get">,
            B extends boolean = false,
            RT extends ResponseType = "json",
        >(
            options?: GetRequestOptions<RouteQuery<N, "get">, RT, B>,
        ) => Promise<ToReturn<T, RT, B>>
    patch: <T = RouteResp<N, "patch">, RT extends ResponseType = "json">(
        options: PatchRequestOptions<RouteQuery<N, "patch">, RT, "json">,
    ) => Promise<RT extends "blob" ? Blob : T>

    post

    post: <T = RouteResp<N, "post">, RT extends ResponseType = "json">(
        options: PostRequestOptions<
            RouteQuery<N, "post">,
            RouteBody<N, "post">,
            RT,
        >,
    ) => Promise<RT extends "blob" ? Blob : T>
    put: <T = RouteResp<N, "put">, RT extends ResponseType = "json">(
        options: PutRequestOptions<
            RouteQuery<N, "put">,
            RouteBody<N, "put">,
            RT,
        >,
    ) => Promise<RT extends "blob" ? Blob : T>
    url: HasRequiredKeys<RouteQuery<N, "get">> extends true
        ? (
            options: Pick<
                GetRequestOptions<RouteQuery<N, "get">, "json", false>,
                "query",
            >,
        ) => Promise<string>
        : (
            options?: Pick<
                GetRequestOptions<RouteQuery<N, "get">, "json", false>,
                "query",
            >,
        ) => Promise<string>