bintastic

Appearance

bintastic / BintasticProject

Class: BintasticProject ​

Defined in: project.ts:4

Extends ​

  • Project

Constructors ​

Constructor ​

new BintasticProject(name?, version?, cb?): BintasticProject

Defined in: project.ts:13

Constructs an instance of a BintasticProject.

Parameters ​

name? ​

string = 'fake-project'

The name of the project. Used within the package.json as the name property.

version? ​

string

The version of the project. Used within the package.json as the version property.

cb? ​

(project) => void

An optional callback for additional setup steps after the project is constructed.

Returns ​

BintasticProject

Overrides ​

Project.constructor

Methods ​

chdir() ​

chdir(): Promise<void>

Defined in: project.ts:34

Changes a directory from inside the project.

Returns ​

Promise<void>

dispose() ​

dispose(): void

Defined in: project.ts:47

Correctly disposes of the project, observing when the directory has been changed.

Returns ​

void

Overrides ​

Project.dispose

gitInit() ​

gitInit(): ResultPromise

Defined in: project.ts:27

Runs git init inside a project.

Returns ​

ResultPromise