Back to Angular

Index.Api

goldens/public-api/common/http/testing/index.api.md

22.0.0-next.102.6 KB
Original Source

API Report File for "@angular/common_http_testing"

Do not edit this file. It is a report generated by API Extractor.

ts

import * as i0 from '@angular/core';
import { Observer } from 'rxjs';
import { Provider } from '@angular/core';

// @public @deprecated
export class HttpClientTestingModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<HttpClientTestingModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<HttpClientTestingModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<HttpClientTestingModule, never, [typeof HttpClientModule], never>;
}

// @public
export abstract class HttpTestingController {
    abstract expectNone(url: string, description?: string): void;
    abstract expectNone(params: RequestMatch, description?: string): void;
    abstract expectNone(matchFn: (req: HttpRequest<any>) => boolean, description?: string): void;
    abstract expectNone(match: string | RequestMatch | ((req: HttpRequest<any>) => boolean), description?: string): void;
    abstract expectOne(url: string, description?: string): TestRequest;
    abstract expectOne(params: RequestMatch, description?: string): TestRequest;
    abstract expectOne(matchFn: (req: HttpRequest<any>) => boolean, description?: string): TestRequest;
    abstract expectOne(match: string | RequestMatch | ((req: HttpRequest<any>) => boolean), description?: string): TestRequest;
    abstract match(match: string | RequestMatch | ((req: HttpRequest<any>) => boolean)): TestRequest[];
    abstract verify(opts?: {
        ignoreCancelled?: boolean;
    }): void;
}

// @public (undocumented)
export function provideHttpClientTesting(): Provider[];

// @public
export interface RequestMatch {
    // (undocumented)
    method?: string;
    // (undocumented)
    url?: string;
}

// @public
export class TestRequest {
    constructor(request: HttpRequest<any>, observer: Observer<HttpEvent<any>>);
    get cancelled(): boolean;
    // @deprecated
    error(error: ErrorEvent, opts?: TestRequestErrorOptions): void;
    error(error: ProgressEvent, opts?: TestRequestErrorOptions): void;
    event(event: HttpEvent<any>): void;
    flush(body: ArrayBuffer | Blob | boolean | string | number | Object | (boolean | string | number | Object | null)[] | null, opts?: {
        headers?: HttpHeaders | {
            [name: string]: string | string[];
        };
        status?: number;
        statusText?: string;
    }): void;
    // (undocumented)
    request: HttpRequest<any>;
}

// (No @packageDocumentation comment for this package)