bintastic

Appearance

bintastic / ResolvedBintasticOptions

Interface: ResolvedBintasticOptions<TProject> ​

Defined in: create-bintastic.ts:34

Options where binPath is an already-resolved absolute path.

Extends ​

  • BintasticOptionsBase<TProject>

Type Parameters ​

TProject ​

TProject

Properties ​

binPath ​

binPath: string | ((project) => string)

Defined in: create-bintastic.ts:20

The path to the bin to invoke.

When importMeta is provided, this is treated as a path relative to the importing module and resolved via fileURLToPath(new URL(binPath, importMeta.url)). Otherwise it must be an absolute path (typically pre-resolved by the caller).

May also be a function that receives the project and returns the path. The returned value is resolved using the same rule.

Inherited from ​

BintasticOptionsBase.binPath

createProject? ​

optional createProject?: () => Promise<TProject>

Defined in: create-bintastic.ts:28

An optional function to use to create the project. Use this if you want to provide a custom implementation of a BintasticProject.

Returns ​

Promise<TProject>

Inherited from ​

BintasticOptionsBase.createProject

importMeta? ​

optional importMeta?: undefined

Defined in: create-bintastic.ts:38

Must be absent. Provide ImportMetaBintasticOptions to resolve a relative binPath.

staticArgs? ​

optional staticArgs?: string[]

Defined in: create-bintastic.ts:24

An array of static arguments that will be used every time when running the bin

Inherited from ​

BintasticOptionsBase.staticArgs