@cucumber/node
    Preparing search index...

    Type Alias TestCaseContext

    A context object injected into every test step function as the first argument.

    type TestCaseContext = {
        assert: TestContext["assert"];
        mock: TestContext["mock"];
        world: World;
        attach(
            data: string | Readable | Buffer<ArrayBufferLike>,
            options: AttachmentOptions,
        ): Promise<void>;
        link(url: string, title?: string): Promise<void>;
        log(text: string): Promise<void>;
        skip(): void;
        todo(): void;
    }
    Index

    Properties

    assert mock world

    Methods

    attach link log skip todo

    Properties

    assert: TestContext["assert"]

    The assert object as provided by the test runner, including the normal methods from node:assert plus extras for dealing with snapshots.

    https://nodejs.org/api/test.html#contextassert

    mock: TestContext["mock"]

    The mock object as provided by the test runner.

    https://nodejs.org/api/test.html#class-mocktracker

    world: World

    An object scoped only to this test case, that can be used to share state between test steps

    Methods

    • Capture an attachment of some content that should be associated with this test step, and might be accessed later in a report

      Parameters

      • data: string | Readable | Buffer<ArrayBufferLike>

        the content to attach, as a stream, buffer or just a plain string

      • options: AttachmentOptions

        declare more information about this attachment

      Returns Promise<void>

    • Capture a URL attachment

      Parameters

      • url: string

        the URL to be captured

      • Optionaltitle: string

        the text title that should accompany the URL

      Returns Promise<void>

      A shorthand for TestCaseContext.attach with a special media type.

    • Capture a "log" attachment.

      Parameters

      • text: string

        the text to be logged

      Returns Promise<void>

      A shorthand for TestCaseContext.attach with a special media type.

    • Mark this test step as skipped. This will cause all subsequent steps to be skipped, except After hooks

      Returns void

      Results in a Cucumber status of "skipped" for the scenario.

    • Mark this test step as pending. This will cause all subsequent steps to be skipped, except After hooks

      Returns void

      Results in a Cucumber status of "pending" for the scenario.

    Settings

    On This Page

    Properties
    Methods
    pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy