Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GitFlowBranch

This interface represents the basic functionality of a git flow branch.

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly defaultBase

defaultBase: GitFlowBaseBranchType

Default base of this branch.

Readonly type

type: GitFlowBranchType

Specifies the git flow entity type.

Methods

finish

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

  • Merges and finishes the branch of the branch type 'type'.

    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>

  • Generates an default branch name.

    Parameters

    • Optional name: string

      A custom name for the branch.

    Returns Promise<undefined | string>

getConfig

list

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

  • Lists all git flow entity of the type 'type'.

    Parameters

    • Optional withPrefix: boolean

      Indicates if the entities should be listed with their prefix.

    Returns Promise<string[]>

start

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

  • Creates and starts a new branch of the type 'type'.

    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.