Interface ISetupTestEventListenerOptions

Options for setupTestEventListener() function.

interface ISetupTestEventListenerOptions {
    binaryParserEncoding?: Nilable<BufferEncoding>;
    eol?: any;
    filter?: Nilable<TestEventHandlerPredicate>;
    getStream?: Nilable<TestOutputStreamProvider>;
    groupPrefix?: any;
    itemPrefix?: any;
    onStatusUpdate?: ((context) => any);
    server: IHttpServer;
}

Properties

binaryParserEncoding? eol? filter? getStream? groupPrefix? itemPrefix? onStatusUpdate? server

Properties

Optional binaryParserEncoding

binaryParserEncoding?: Nilable<BufferEncoding>

Custom encoding for binary parser, which is used to parse a supertest response.

Default

"binary"

Optional eol

eol?: any

Custom value for EOL.

Default

SYSTEM_EOL

Optional filter

filter?: Nilable<TestEventHandlerPredicate>

The custom test filter.

Optional getStream

getStream?: Nilable<TestOutputStreamProvider>

A custom function, which returns the stream for the output.

Optional groupPrefix

groupPrefix?: any

The prefix, when group name is printed.

Default

"🧪 "

Optional itemPrefix

itemPrefix?: any

The custom indent for a test item.

Default

"\t"

Optional onStatusUpdate

onStatusUpdate?: ((context) => any)

Optional callback, which is invoked, when status of a test is updated.

Type declaration

    • (context): any

    • Optional callback, which is invoked, when status of a test is updated.

      Parameters

      Returns any

Param: context

The execution context.

server

server: IHttpServer

The underlying server to setup.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc