Skip to content

bintastic / CreateBintasticResult

Interface: CreateBintasticResult<TProject> ​

Defined in: create-bintastic.ts:93

The result returned by createBintastic.

Type Parameters ​

TProject ​

TProject extends BintasticProject

Properties ​

runBin ​

runBin: RunBin

Defined in: create-bintastic.ts:97

Runs the configured bin function via execa.


runBinDebug ​

runBinDebug: RunBin

Defined in: create-bintastic.ts:116

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


setupProject ​

setupProject: () => Promise<TProject>

Defined in: create-bintastic.ts:101

Sets up the specified project for use within tests.

Returns ​

Promise<TProject>


setupTmpDir ​

setupTmpDir: () => Promise<string>

Defined in: create-bintastic.ts:105

Sets up a tmp directory for use within tests.

Returns ​

Promise<string>


teardownProject ​

teardownProject: () => void

Defined in: create-bintastic.ts:111

Tears the project down: restores the cwd from project.chdir() and removes the tmp directory. In debug mode (runBinDebug or BINTASTIC_DEBUG) the directory is kept on disk and its path logged. Safe to call when no project is active.

Returns ​

void