Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AvhGitFlowBranch Abstract

This class implements the basic functionality of a git flow branch.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of this class.

    Parameters

    • Optional repoPath: string

      The path to the git repository.

    Returns AvhGitFlowBranch

Properties

Readonly Abstract defaultBase

defaultBase: GitFlowBaseBranchType

{@inheritdoc}

Readonly Abstract type

type: GitFlowBranchType

{@inheritdoc}

Methods

finish

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

  • {@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>

  • {@inheritdoc}

    Parameters

    • Optional name: string

      A custom name for the branch.

    Returns Promise<undefined | string>

    The generated branch name.

Abstract getConfig

list

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

  • {@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>

  • {@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.