Class FeatureGitFlowBranch

This class wraps the feature branch of the AVH implementation.

Hierarchy

AvhGitFlowBranch
- FeatureGitFlowBranch

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FeatureGitFlowBranch(repoPath?: string, configProvider?: ConfigProvider<GitFlowConfig>): FeatureGitFlowBranch

Overrides AvhGitFlowBranch.constructor

Initializes a new instance of this class.

Parameters
- Optional repoPath: string
  
  The path to the git repository.
- Optional configProvider: ConfigProvider<GitFlowConfig>
  
  Git flow config provider.
Returns FeatureGitFlowBranch

Properties

Readonly defaultBase

defaultBase: GitFlowBaseBranchType = 'develop'

{@inheritdoc}

Readonly type

type: GitFlowBranchType = 'feature'

{@inheritdoc}

Methods

finish

finish(name?: string, msg?: string): Promise<void>

Inherited from AvhGitFlowBranch.finish

{@inheritdoc}

Parameters
- Optional name: string
  
  Name of the branch to be finished.
- Optional msg: string
  
  Message to be set for finishing the branch.
Returns Promise<void>

generateBranchName

generateBranchName(name?: string): Promise<undefined | string>

Inherited from AvhGitFlowBranch.generateBranchName

{@inheritdoc}

Parameters
- Optional name: string
  
  A custom name for the branch.
Returns Promise<undefined | string>
The generated branch name.

getConfig

getConfig(): Promise<GitFlowBranchConfig>

Overrides AvhGitFlowBranch.getConfig

{@inheritdoc}

Returns Promise<GitFlowBranchConfig>
The configuration of the feature git flow branch.

list

list(withPrefix?: boolean): Promise<string[]>

Inherited from AvhGitFlowBranch.list

{@inheritdoc}

Parameters
- Optional withPrefix: boolean
  
  Indicates if the entities should be listed with their prefix.
Returns Promise<string[]>
The list of the currently opened branch.

start

start(name?: string, base?: string): Promise<string>

Inherited from AvhGitFlowBranch.start

{@inheritdoc}

Parameters
- Optional name: string
  
  Name of the branch to be started.
- Optional base: string
  
  Base of the branch should be started from.
Returns Promise<string>
The git reference of the create branch.