Class Jest

Hierarchy

  • Jest
    • Jest

Constructors

constructor

Properties

config file? jestVersion project

Methods

addIgnorePattern addReporter addSetupFile addSetupFileAfterEnv addSnapshotResolver addTestMatch addWatchIgnorePattern postSynthesize preSynthesize synthesize of

Constructors

constructor

  • Parameters

    Returns Jest

Properties

Readonly config

config: any

Escape hatch.

Optional Readonly file

file?: JsonFile

Jest config file. undefined if settings are written to package.json

Readonly jestVersion

jestVersion: string

Jest version, including @ symbol, like @^29

Readonly project

project: Project

Methods

addIgnorePattern

  • Parameters

    • pattern: string

    Returns void

addReporter

  • Parameters

    • reporter: JestReporter

    Returns void

addSetupFile

  • Adds a a setup file to Jest's setupFiles configuration.

    Parameters

    • file: string

      File path to setup file

    Returns void

addSetupFileAfterEnv

  • Adds a a setup file to Jest's setupFilesAfterEnv configuration.

    Parameters

    • file: string

      File path to setup file

    Returns void

addSnapshotResolver

  • Parameters

    • file: string

    Returns void

addTestMatch

  • Adds a test match pattern.

    Parameters

    • pattern: string

      glob pattern to match for tests

    Returns void

addWatchIgnorePattern

  • Adds a watch ignore pattern.

    Parameters

    • pattern: string

      The pattern (regular expression).

    Returns void

postSynthesize

  • Called after synthesis. Order is not guaranteed.

    Returns void

preSynthesize

  • Returns void

synthesize

  • Synthesizes files to the project output directory.

    Returns void

Static of

  • Returns the singletone Jest component of a project or undefined if there is none.

    Parameters

    • project: Project

    Returns undefined | Jest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc