Class Git

constructor

• new Git(dir: string): Git

  Parameters

  • dir: string

  Returns Git

Readonlydir

commitTree

• commitTree(
      tree: string,
      parent: string,
      message: string,
      identity?: { email: string; name: string },
  ): Promise<string>

  Parameters

  • tree: string
  • parent: string
  • message: string
  • Optionalidentity: { email: string; name: string }

  Returns Promise<string>

configGet

• configGet(key: string): Promise<null | string>

  Parameters

  • key: string

  Returns Promise<null | string>

defaultBranch

• defaultBranch(): Promise<string>

  The repo's default branch: origin/HEAD when set, else main/master (local, then remote-tracking — CI checkouts detach HEAD with no local branches), else the current HEAD's branch.

  Returns Promise<string>

diff

• diff(base: string, head: string, pathspec?: string[]): Promise<string>

  Parameters

  • base: string
  • head: string
  • pathspec: string[] = []

  Returns Promise<string>

forEachRef

• forEachRef(patterns: string[]): Promise<RefInfo[]>

  Parameters

  • patterns: string[]

  Returns Promise<RefInfo[]>

hashObject

• hashObject(content: string): Promise<string>

  Parameters

  • content: string

  Returns Promise<string>

isAncestor

• isAncestor(maybeAncestor: string, of: string): Promise<boolean>

  Parameters

  • maybeAncestor: string
  • of: string

  Returns Promise<boolean>

lastTouched

• lastTouched(rev: string, paths: string[]): Promise<null | CommitInfo>

  Most recent commit on rev touching any of paths, or null.

  Parameters

  • rev: string
  • paths: string[]

  Returns Promise<null | CommitInfo>

lastTouchedExcept

• lastTouchedExcept(
      rev: string,
      dir: string,
      excludePaths: string[],
  ): Promise<null | CommitInfo>

  Most recent commit on rev touching anything under dir except excludePaths, or null.

  Parameters

  • rev: string
  • dir: string
  • excludePaths: string[]

  Returns Promise<null | CommitInfo>

log

• log(
      rev: string,
      paths?: string[],
      opts?: { maxCount?: number; topoOrder?: boolean },
  ): Promise<CommitInfo[]>

  Parameters

  • rev: string
  • paths: string[] = []
  • opts: { maxCount?: number; topoOrder?: boolean } = {}

  Returns Promise<CommitInfo[]>

lsTree

• lsTree(rev: string, path: string): Promise<string[]>

  Paths (relative to path) of blobs under rev:path. Empty when missing.

  Parameters

  • rev: string
  • path: string

  Returns Promise<string[]>

lsTreeDirs

• lsTreeDirs(rev: string, path: string): Promise<string[]>

  Top-level directory names under rev:path.

  Parameters

  • rev: string
  • path: string

  Returns Promise<string[]>

mergeBase

• mergeBase(a: string, b: string): Promise<null | string>

  Parameters

  • a: string
  • b: string

  Returns Promise<null | string>

objectId

• objectId(rev: string, path: string): Promise<null | string>

  Object id of rev:path — a tree for a directory, a blob for a file — or null when that path does not exist at that rev. Content identity without reading the content: two revs naming the same tree carry byte-identical directories.

  Parameters

  • rev: string
  • path: string

  Returns Promise<null | string>

revListCount

• revListCount(range: string): Promise<null | number>

  git rev-list --count <range>, or null when a ref in the range is unknown.

  Parameters

  • range: string

  Returns Promise<null | number>

revParse

• revParse(rev: string): Promise<null | string>

  Parameters

  • rev: string

  Returns Promise<null | string>

run

• run(
      args: string[],
      opts?: { env?: Record<string, string>; input?: string },
  ): Promise<string>

  Parameters

  • args: string[]
  • opts: { env?: Record<string, string>; input?: string } = {}

  Returns Promise<string>

show

• show(rev: string, path: string): Promise<null | string>

  Content of path at rev, or null when the path/rev doesn't exist.

  Parameters

  • rev: string
  • path: string

  Returns Promise<null | string>

toplevel

• toplevel(): Promise<string>

  Returns Promise<string>

updateRefCAS

• updateRefCAS(ref: string, newOid: string, expectedOld: string): Promise<boolean>

  Atomic compare-and-swap ref update. Returns false when the ref no longer points at expectedOld — the caller re-reads and re-presents.

  Parameters

  • ref: string
  • newOid: string
  • expectedOld: string

  Returns Promise<boolean>

worktrees

• worktrees(): Promise<WorktreeInfo[]>

  Returns Promise<WorktreeInfo[]>

writeTreeWithBlob

• writeTreeWithBlob(
      baseCommit: string,
      path: string,
      blobOid: string,
  ): Promise<string>

  Build a tree that is baseCommit's tree with one blob replaced, without touching any index or working tree the user owns.

  Parameters

  • baseCommit: string
  • path: string
  • blobOid: string

  Returns Promise<string>