Suite
[<Interface>]
type Suite =
abstract member Invoke (?fn: SuiteFn) : Promise<unit>
abstract member Invoke (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member Invoke (?name: string, ?fn: SuiteFn) : Promise<unit>
abstract member Invoke (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member only (?fn: SuiteFn) : Promise<unit>
abstract member only (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member only (?name: string, ?fn: SuiteFn) : Promise<unit>
abstract member only (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member skip (?fn: SuiteFn) : Promise<unit>
abstract member skip (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member skip (?name: string, ?fn: SuiteFn) : Promise<unit>
abstract member skip (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member todo (?fn: SuiteFn) : Promise<unit>
abstract member todo (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member todo (?name: string, ?fn: SuiteFn) : Promise<unit>
abstract member todo (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>| Assembly | Xantham.Fable.Node |
Methods
abstract member Invoke (?fn: SuiteFn) : Promise<unit>
abstract member Invoke (?fn: SuiteFn) : Promise<unit>The suite() function is imported from the node:test module.
@since v20.13.0
| Parameter | |
|---|---|
name | The name of the suite, which is displayed when reporting test results. Defaults to the name property of fn, or '<anonymous>' if fn does not have a name. |
options | Configuration options for the suite. This supports the same options as {@link test}. |
fn | The suite function declaring nested tests and suites. The first argument to this function is a {@link SuiteContext} object. |
Returns. Immediately fulfilled with undefined.
abstract member Invoke (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member Invoke (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>The suite() function is imported from the node:test module.
@since v20.13.0
| Parameter | |
|---|---|
name | The name of the suite, which is displayed when reporting test results. Defaults to the name property of fn, or '<anonymous>' if fn does not have a name. |
options | Configuration options for the suite. This supports the same options as {@link test}. |
fn | The suite function declaring nested tests and suites. The first argument to this function is a {@link SuiteContext} object. |
Returns. Immediately fulfilled with undefined.
abstract member Invoke (?name: string, ?fn: SuiteFn) : Promise<unit>
abstract member Invoke (?name: string, ?fn: SuiteFn) : Promise<unit>The suite() function is imported from the node:test module.
@since v20.13.0
| Parameter | |
|---|---|
name | The name of the suite, which is displayed when reporting test results. Defaults to the name property of fn, or '<anonymous>' if fn does not have a name. |
options | Configuration options for the suite. This supports the same options as {@link test}. |
fn | The suite function declaring nested tests and suites. The first argument to this function is a {@link SuiteContext} object. |
Returns. Immediately fulfilled with undefined.
abstract member Invoke (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member Invoke (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>The suite() function is imported from the node:test module.
@since v20.13.0
| Parameter | |
|---|---|
name | The name of the suite, which is displayed when reporting test results. Defaults to the name property of fn, or '<anonymous>' if fn does not have a name. |
options | Configuration options for the suite. This supports the same options as {@link test}. |
fn | The suite function declaring nested tests and suites. The first argument to this function is a {@link SuiteContext} object. |
Returns. Immediately fulfilled with undefined.
abstract member only (?fn: SuiteFn) : Promise<unit>
abstract member only (?fn: SuiteFn) : Promise<unit>Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.
@since v20.13.0
abstract member only (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member only (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.
@since v20.13.0
abstract member only (?name: string, ?fn: SuiteFn) : Promise<unit>
abstract member only (?name: string, ?fn: SuiteFn) : Promise<unit>Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.
@since v20.13.0
abstract member only (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member only (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.
@since v20.13.0
abstract member skip (?fn: SuiteFn) : Promise<unit>
abstract member skip (?fn: SuiteFn) : Promise<unit>Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.
@since v20.13.0
abstract member skip (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member skip (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.
@since v20.13.0
abstract member skip (?name: string, ?fn: SuiteFn) : Promise<unit>
abstract member skip (?name: string, ?fn: SuiteFn) : Promise<unit>Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.
@since v20.13.0
abstract member skip (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member skip (?name: string, ?options: TestOptions, ?fn: SuiteFn) : Promise<unit>Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.
@since v20.13.0
abstract member todo (?fn: SuiteFn) : Promise<unit>
abstract member todo (?fn: SuiteFn) : Promise<unit>Shorthand for marking a suite as TODO. This is the same as calling suite with options.todo set to true.
@since v20.13.0
abstract member todo (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>
abstract member todo (?options: TestOptions, ?fn: SuiteFn) : Promise<unit>Shorthand for marking a suite as TODO. This is the same as calling suite with options.todo set to true.
@since v20.13.0