rulvar API reference

---

rulvar API reference / @rulvar/rulvar / GitWorktreeProvider

Class: GitWorktreeProvider

Defined in: packages/core/dist/index.d.ts

The shipped git worktree lifecycle. A non-git host is a typed ConfigError at acquire.

Implements

• IsolationProvider

Constructors

Constructor

new GitWorktreeProvider(options?): GitWorktreeProvider;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
options?	GitWorktreeProviderOptions

Returns

GitWorktreeProvider

Accessors

pinnedWorktrees

Get Signature

get pinnedWorktrees(): ReadonlySet<string>;

Defined in: packages/core/dist/index.d.ts

Trees currently retained under the pin cap.

Returns

ReadonlySet<string>

Methods

acquire()

acquire(spawn): Promise<{
  cwd: string;
  collect: Promise<{
     files: string[];
     patch: Bytes;
  }>;
  dispose: Promise<void>;
}>;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
spawn	{ ref?: string; runId: string; spanId: string; }
spawn.ref?	string
spawn.runId	string
spawn.spanId	string

Returns

Promise<{ cwd: string; collect: Promise<{ files: string[]; patch: Bytes; }>; dispose: Promise&lt;void&gt;; }>

Implementation of

IsolationProvider.acquire