Interface ITestSettings

Options, setting up a test.

interface ITestSettings {
    after?: Nilable<AfterEachTestFunc>;
    before?: Nilable<BeforeEachTestFunc>;
    body?: any;
    expectations?: Nilable<ITestSettingExpectations>;
    headers?: Nilable<TestSettingValueOrGetter<Record<string, any>>>;
    parameters?: Nilable<TestSettingValueOrGetter<Record<string, string>>>;
    query?: Nilable<TestSettingValueOrGetter<Record<string, string>>>;
    ref?: any;
    sortOrder?: any;
    tag?: any;
    timeout?: Nilable<TestSettingValueOrGetter<number>>;
    validator?: Nilable<TestResponseValidator>;
}

Properties

after? before? body? expectations? headers? parameters? query? ref? sortOrder? tag? timeout? validator?

Properties

Optional after

after?: Nilable<AfterEachTestFunc>

An additional function, which is executed AFTER the underlying test.

Optional before

before?: Nilable<BeforeEachTestFunc>

An additional function, which is executed before the underlying test.

Optional body

body?: any

Request body.

Optional expectations

expectations?: Nilable<ITestSettingExpectations>

Sets up the expectations.

Optional headers

headers?: Nilable<TestSettingValueOrGetter<Record<string, any>>>

Request headers.

Optional parameters

parameters?: Nilable<TestSettingValueOrGetter<Record<string, string>>>

URL parameters.

Optional query

query?: Nilable<TestSettingValueOrGetter<Record<string, string>>>

Query parameters.

Optional ref

ref?: any

This is an explicit reference to the underlying test, declared by things like @It() decorator.

Optional sortOrder

sortOrder?: any

A custom sort order, inside the group.

Optional tag

tag?: any

Something optional, that should submitted to a test event / operation.

Optional timeout

timeout?: Nilable<TestSettingValueOrGetter<number>>

Custom timeout value in ms.

Optional validator

validator?: Nilable<TestResponseValidator>

A custom validator function.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc