Interface SuiteCollector<ExtraContext>

interface SuiteCollector<ExtraContext> {
    clear: (() => void);
    collect: ((file?) => Promise<Suite>);
    mode: RunMode;
    name: string;
    on: (<T>(name, ...fn) => void);
    options?: TestOptions;
    task: ((name, options?) => Custom<ExtraContext>);
    tasks: (SuiteCollector<ExtraContext> | Suite | Custom<ExtraContext> | Test<ExtraContext>)[];
    test: TestAPI<ExtraContext>;
    type: "collector";
}

Type Parameters

ExtraContext = {}

Index

Properties

clear collect mode name on options? task tasks test type

Properties

clear

clear: (() => void)

Type declaration

- (): void
- Returns void

collect

collect: ((file?) => Promise<Suite>)

Type declaration

- (file?): Promise<Suite>
- Parameters
  - Optional file: File
  Returns Promise<Suite>

`Readonly` mode

`Readonly` name

name: string

on

on: (<T>(name, ...fn) => void)

Type declaration

- <T>(name, ...fn): void
- Type Parameters
  - T extends keyof SuiteHooks<ExtraContext>
  Parameters
  - name: T
  - Rest ...fn: SuiteHooks<ExtraContext>[T]
  Returns void

`Optional` options

options?: TestOptions

task

task: ((name, options?) => Custom<ExtraContext>)

Type declaration

- (name, options?): Custom<ExtraContext>
- Parameters
  - name: string
  - Optional options: TaskCustomOptions
  Returns Custom<ExtraContext>

tasks

tasks: (SuiteCollector<ExtraContext> | Suite | Custom<ExtraContext> | Test<ExtraContext>)[]

test

test: TestAPI<ExtraContext>

type

type: "collector"

Generated using TypeDoc