Type alias UnitTestProps

UnitTestProps: {
    description?: string | false | null;
    id?: string;
    isCodeBlock?: boolean;
    name?: string;
    parameters?: WithCy<any>;
}

Props for the UnitTest component, mostly to link to story

Type declaration

  • Optional description?: string | false | null

    description for tests which have cy function or cyTest formats. Provides a reasonable default but can opt out with false

  • Optional id?: string

    id matching the story's name. either name or id must be provided

  • Optional isCodeBlock?: boolean

    Potentially internal only: if the literate test is from code block. Used to deduplicate display of code block in docs view

  • Optional name?: string

    name matching the story's name

  • Optional parameters?: WithCy<any>

    Parameters, probably passed in from parent in unitTestDecorator, though I suppose passing in directly could be useful somehow

Settings

Member Visibility

Theme