vapor-chamber API reference - v1.3.0
    Preparing search index...

    Type Alias HttpClient

    type HttpClient = {
        get<T = unknown>(
            url: string,
            config?: HttpRequestConfig,
        ): Promise<HttpResponse<T>>;
        post<T = unknown>(
            url: string,
            data?: unknown,
            config?: HttpRequestConfig,
        ): Promise<HttpResponse<T>>;
        put<T = unknown>(
            url: string,
            data?: unknown,
            config?: HttpRequestConfig,
        ): Promise<HttpResponse<T>>;
        patch<T = unknown>(
            url: string,
            data?: unknown,
            config?: HttpRequestConfig,
        ): Promise<HttpResponse<T>>;
        delete<T = unknown>(
            url: string,
            config?: HttpRequestConfig,
        ): Promise<HttpResponse<T>>;
        request<T = unknown>(
            url: string,
            config?: HttpRequestConfig,
        ): Promise<HttpResponse<T>>;
        download(
            url: string,
            filename?: string,
            config?: HttpRequestConfig,
        ): Promise<DownloadResult>;
        safe: {
            get<T = unknown>(
                url: string,
                config?: HttpRequestConfig,
            ): Promise<SafeResult<T>>;
            post<T = unknown>(
                url: string,
                data?: unknown,
                config?: HttpRequestConfig,
            ): Promise<SafeResult<T>>;
            put<T = unknown>(
                url: string,
                data?: unknown,
                config?: HttpRequestConfig,
            ): Promise<SafeResult<T>>;
            patch<T = unknown>(
                url: string,
                data?: unknown,
                config?: HttpRequestConfig,
            ): Promise<SafeResult<T>>;
            delete<T = unknown>(
                url: string,
                config?: HttpRequestConfig,
            ): Promise<SafeResult<T>>;
        };
        interceptors: {
            request: InterceptorManager<HttpRequestConfig>;
            response: InterceptorManager<HttpResponse>;
        };
        create(defaults?: Partial<HttpRequestConfig>): HttpClient;
        clearCache(): void;
        invalidateCache(pattern: string | RegExp): void;
    }
    Index

    Methods

    get post put patch delete request download create clearCache invalidateCache

    Properties

    safe interceptors

    Methods

    post

    • Parameters

      • pattern: string | RegExp

      Returns void

    Properties

    safe: {
        get<T = unknown>(
            url: string,
            config?: HttpRequestConfig,
        ): Promise<SafeResult<T>>;
        post<T = unknown>(
            url: string,
            data?: unknown,
            config?: HttpRequestConfig,
        ): Promise<SafeResult<T>>;
        put<T = unknown>(
            url: string,
            data?: unknown,
            config?: HttpRequestConfig,
        ): Promise<SafeResult<T>>;
        patch<T = unknown>(
            url: string,
            data?: unknown,
            config?: HttpRequestConfig,
        ): Promise<SafeResult<T>>;
        delete<T = unknown>(
            url: string,
            config?: HttpRequestConfig,
        ): Promise<SafeResult<T>>;
    }
    interceptors: {
        request: InterceptorManager<HttpRequestConfig>;
        response: InterceptorManager<HttpResponse>;
    }

    Settings

    Member Visibility

    On This Page

    Methods
    Properties