Reference

import { /* ... */ } from 'git-edge';

Merge

functionthreeWayMerge

threeWayMerge(repo: Repo, sourceRef: string, targetRef: string, opts?: MergeOpts): Promise<MergeResult>

Parameter	Type	Description
opts.message?	string	Default `Merge ${sourceRef} into ${targetRef}`.
opts.authorName?	string	Default "Git Edge".
opts.authorEmail?	string	Default "git-edge@local".

Returns: Promise<{ commitOid: string }>

Object-level three-way merge — no worktree. Throws GitMergeConflictError on unresolved content conflicts. See Three-way merge for the full decision tree.

Parsed-object cache

functioncreateParsedObjectCache

createParsedObjectCache(options?: ParsedObjectCacheOptions): ParsedObjectStore

Parameter	Type	Description
options.maxSize?	number	Approximate byte budget; each entry is sized by walking its value (no serialization). Default 256 MiB.
options.ttl?	number	Entry TTL in ms. Default 1 hour.

Returns: ParsedObjectStore

A generic in-memory LRU for any JS value, keyed however you like. See the parsed-object cache guide.

ParsedObjectStore — the returned interface:

interface ParsedObjectStore {
  get<T extends object>(key: string): T | null;
  set<T extends object>(key: string, value: T): void;
  delete(key: string): void;
  invalidatePrefix(prefix: string): void;
}

Repo cache

functiongetRepoCache

getRepoCache(ownerKey: string, repoName: string): object

Returns: object

The long-lived isomorphic-git packfile cache for a repo, created on first access. See Repo cache.

functioninvalidateRepoCache

invalidateRepoCache(ownerKey: string, repoName: string): void

Drops a repo’s cached packfile state — call after any out-of-process storage rewrite.

Errors

classGitEdgeError

class GitEdgeError extends Error

Base class for every error this package throws.

classGitMergeConflictError

class GitMergeConflictError extends GitEdgeError

Thrown only by threeWayMerge. Carries conflictingPaths: string[].

Note

git-edge’s error hierarchy is separate from git-fs-s3’s — if you compose the two packages and want a single instanceof check across both, catch each package’s error classes explicitly rather than assuming a shared base class.

Types

Export	Shape
Repo	{ fs: IsoGitFs; gitdir: string; cache?: object }
MergeOpts	{ message?, authorName?, authorEmail? }
MergeResult	{ commitOid: string }
ParsedObjectCacheOptions	{ maxSize?: number; ttl?: number }