Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Branch

A branch.

Hierarchy

  • Branch

Index

Properties

client

The client, the branch belongs to.

commitCount

commitCount: function

Returns the number of total commits.

param

Number of items to skip.

returns

The result with the number of commit.

Type declaration

    • (skip?: number): number | PromiseLike<number>
    • Parameters

      • Optional skip: number

      Returns number | PromiseLike<number>

commits

commits: function

Returns all commits of that branch in descending order.

param

The page.

param

Number of items to skip.

returns

The result with the list of branches.

Type declaration

    • (page?: number, skip?: number): Commit[] | PromiseLike<Commit[]>
    • Parameters

      • Optional page: number
      • Optional skip: number

      Returns Commit[] | PromiseLike<Commit[]>

id

id: string

The ID / name of the branch.

Optional lastCommit

lastCommit: object

Data of the last commit.

Type declaration

  • id: string

    ID / hash.

  • Optional subject?: string

    Short version of commit message.

Generated using TypeDoc