On this page

    M

    suite

    History
    suite(name?, options?, fn): Promise
    Attributes
    name?:string
    The suite name. Default: The name property of fn, or '<anonymous>' when fn has no name.
    options:Object
    diagnosticChannels?:Array
    String diagnostics channel names inherited by nested suites and benchmarks. Symbol values in the array are silently ignored. Default: [].
    only?:boolean
    Selects all benchmarks nested in this suite. Default: false.
    skip?:boolean | string
    Skips all benchmarks nested in this suite. Default: false.
    tags?:string[]
    Labels inherited by nested suites and benchmarks. Default: [].
    fn:Function | AsyncFunction
    A function that declares nested suites, benchmarks, and hooks.
    Returns:Promise
    Fulfilled when a top-level suite finishes, or with undefined immediately when declared in another suite.

    Suite functions run while declarations are collected. Promise-returning suite functions are awaited before benchmark execution begins.

    PreviousbenchNextdescribe