Interface CreateBintasticResult<TProject>

The result returned by createBintastic.

interface CreateBintasticResult<TProject extends BintasticProject> {
    runBin: RunBin;
    runBinDebug: RunBin;
    setupProject: () => Promise<TProject>;
    setupTmpDir: () => Promise<string>;
    teardownProject: () => void;
}

Properties

runBin: RunBin

Runs the configured bin function via execa.

runBinDebug: RunBin

Runs the configured bin with Node inspector enabled in attach mode (--inspect). Set BINTASTIC_DEBUG=break to break on first line instead.

setupProject: () => Promise<TProject>

Sets up the specified project for use within tests.

setupTmpDir: () => Promise<string>

Sets up a tmp directory for use within tests.

teardownProject: () => void

Tears the project down, ensuring the tmp directory is removed. When BINTASTIC_DEBUG is set, fixtures are preserved for inspection.