Type Alias: CheckoutOptions

Documentation / @wtf/project-wpt / checkout / CheckoutOptions

type CheckoutOptions = object;

Defined in: packages/project-wpt/src/checkout.ts:41

Where a checkout is, and what it fetches.

Properties

cache?

readonly optional cache?: string;

Defined in: packages/project-wpt/src/checkout.ts:66

The folder of the checkouts, each by its commit, in place of the project’s cache.

---

commit

readonly commit: string;

Defined in: packages/project-wpt/src/checkout.ts:62

The commit of the WPT, its full hash.

---

exec

readonly exec: Exec;

Defined in: packages/project-wpt/src/checkout.ts:58

Runs git, to its end, in a folder and an environment: nodeExec of ./node, in Node.

---

files

readonly files: Pick<WptFiles,
  | "exists"
  | "readFile"
  | "readdir"
  | "create"
  | "modified"
  | "mkdir"
| "remove">;

Defined in: packages/project-wpt/src/checkout.ts:47

The file system the checkout is looked for and read by, the handles of the platform’s: what is there and what a file holds, and the lock beside the checkout, which one process makes by creating a file no other can. The fetch itself, by git, is the disk’s.

---

platform

readonly platform: Pick<WptPlatform, "env" | "setTimeout" | "performance">;

Defined in: packages/project-wpt/src/checkout.ts:56

What the checkout reads of the platform: the environment git runs in, setTimeout, which the wait for the lock of another process is made by, and performance, whose clock tells how old that lock is.

---

repository?

readonly optional repository?: string;

Defined in: packages/project-wpt/src/checkout.ts:64

The git repository of the WPT, the WPT’s own on GitHub by default.

---

root

readonly root: string;

Defined in: packages/project-wpt/src/checkout.ts:60

The root of the project, whose node_modules/.cache/wpt keeps the checkouts.