rxrest-assert/lib/index.d.ts

Assert library for RxRest

/// <reference path="../node-status-code.d.ts" />
import { RxRestConfiguration } from 'rxrest';
export declare type RequestIdentifier = {
    url: string | RegExp;
    method: string;
};
export declare type TestFunction = (request: Request) => boolean;
export declare type RxRestAssertOptions = {
    log: boolean;
};
export declare type Respond = (response: Response | Object | number) => Assertion;
export declare type Assertion = {
    method: string;
    url: string;
    respond: Respond;
};
export declare class RxRestAssertionError extends TypeError {
}
export declare class RxRestAssert {
    $expectations: any[];
    $whens: Map<RequestIdentifier, any>;
    $requestInterceptorIndex: number;
    $responseInterceptorIndex: number;
    $current: any;
    $requestCount: number;
    log: boolean;
    config: RxRestConfiguration;
    constructor(config: RxRestConfiguration, options?: RxRestAssertOptions);
    $expectation(method: string, url: string | RegExp, data?: Request | TestFunction, assertion?: boolean): any;
    $log(message: string): void;
    $throw(message: string): void;
    $getRequestURL(request: Request): string;
    $matchURL(url: string | RegExp, requestURL: string): boolean;
    expect(method: string, url: string | RegExp, data?: Request | TestFunction): {
        respond: Respond;
    };
    expectGET(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    expectPOST(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    expectPUT(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    expectHEAD(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    expectPATCH(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    expectDELETE(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    when(method: string, url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    whenGET(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    whenPOST(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    whenPUT(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    whenHEAD(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    whenPATCH(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    whenDELETE(url: string | RegExp, data?: Request): {
        respond: Respond;
    };
    resetExpectations(): void;
    verifyNoOutstandingExpectation(): void;
    verifyNoOutstandingRequest(): void;
    destroy(): void;
}