/** * @license Angular v17.1.3 * (c) 2010-2022 Google LLC. https://angular.io/ * License: MIT */ import { HttpEvent } from '@angular/common/http'; import { HttpHeaders } from '@angular/common/http'; import { HttpRequest } from '@angular/common/http'; import * as i0 from '@angular/core'; import * as i1 from '@angular/common/http'; import { Observer } from 'rxjs'; import { Provider } from '@angular/core'; /** * Configures `HttpClientTestingBackend` as the `HttpBackend` used by `HttpClient`. * * Inject `HttpTestingController` to expect and flush requests in your tests. * * @publicApi */ export declare class HttpClientTestingModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Controller to be injected into tests, that allows for mocking and flushing * of requests. * * @publicApi */ export declare abstract class HttpTestingController { /** * Search for requests that match the given parameter, without any expectations. */ abstract match(match: string | RequestMatch | ((req: HttpRequest) => boolean)): TestRequest[]; /** * Expect that a single request has been made which matches the given URL, and return its * mock. * * If no such request has been made, or more than one such request has been made, fail with an * error message including the given request description, if any. */ abstract expectOne(url: string, description?: string): TestRequest; /** * Expect that a single request has been made which matches the given parameters, and return * its mock. * * If no such request has been made, or more than one such request has been made, fail with an * error message including the given request description, if any. */ abstract expectOne(params: RequestMatch, description?: string): TestRequest; /** * Expect that a single request has been made which matches the given predicate function, and * return its mock. * * If no such request has been made, or more than one such request has been made, fail with an * error message including the given request description, if any. */ abstract expectOne(matchFn: (req: HttpRequest) => boolean, description?: string): TestRequest; /** * Expect that a single request has been made which matches the given condition, and return * its mock. * * If no such request has been made, or more than one such request has been made, fail with an * error message including the given request description, if any. */ abstract expectOne(match: string | RequestMatch | ((req: HttpRequest) => boolean), description?: string): TestRequest; /** * Expect that no requests have been made which match the given URL. * * If a matching request has been made, fail with an error message including the given request * description, if any. */ abstract expectNone(url: string, description?: string): void; /** * Expect that no requests have been made which match the given parameters. * * If a matching request has been made, fail with an error message including the given request * description, if any. */ abstract expectNone(params: RequestMatch, description?: string): void; /** * Expect that no requests have been made which match the given predicate function. * * If a matching request has been made, fail with an error message including the given request * description, if any. */ abstract expectNone(matchFn: (req: HttpRequest) => boolean, description?: string): void; /** * Expect that no requests have been made which match the given condition. * * If a matching request has been made, fail with an error message including the given request * description, if any. */ abstract expectNone(match: string | RequestMatch | ((req: HttpRequest) => boolean), description?: string): void; /** * Verify that no unmatched requests are outstanding. * * If any requests are outstanding, fail with an error message indicating which requests were not * handled. * * If `ignoreCancelled` is not set (the default), `verify()` will also fail if cancelled requests * were not explicitly matched. */ abstract verify(opts?: { ignoreCancelled?: boolean; }): void; } export declare function provideHttpClientTesting(): Provider[]; /** * Defines a matcher for requests based on URL, method, or both. * * @publicApi */ export declare interface RequestMatch { method?: string; url?: string; } /** * A mock requests that was received and is ready to be answered. * * This interface allows access to the underlying `HttpRequest`, and allows * responding with `HttpEvent`s or `HttpErrorResponse`s. * * @publicApi */ export declare class TestRequest { request: HttpRequest; private observer; /** * Whether the request was cancelled after it was sent. */ get cancelled(): boolean; constructor(request: HttpRequest, observer: Observer>); /** * Resolve the request by returning a body plus additional HTTP information (such as response * headers) if provided. * If the request specifies an expected body type, the body is converted into the requested type. * Otherwise, the body is converted to `JSON` by default. * * Both successful and unsuccessful responses can be delivered via `flush()`. */ 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; /** * Resolve the request by returning an `ErrorEvent` (e.g. simulating a network failure). * @deprecated Http requests never emit an `ErrorEvent`. Please specify a `ProgressEvent`. */ error(error: ErrorEvent, opts?: TestRequestErrorOptions): void; /** * Resolve the request by returning an `ProgressEvent` (e.g. simulating a network failure). */ error(error: ProgressEvent, opts?: TestRequestErrorOptions): void; /** * Deliver an arbitrary `HttpEvent` (such as a progress event) on the response stream for this * request. */ event(event: HttpEvent): void; } /** * Type that describes options that can be used to create an error * in `TestRequest`. */ declare type TestRequestErrorOptions = { headers?: HttpHeaders | { [name: string]: string | string[]; }; status?: number; statusText?: string; }; export { }