lightbox

Delete a snapshot

removeSnapshot().

removeSnapshot(name, opts?) → Promise<void>

Delete a snapshot artifact. Idempotent — silently succeeds if the snapshot isn’t there.

import { removeSnapshot } from "@beamhop/lightbox";

await removeSnapshot("rust-ci");
await removeSnapshot("rust-ci", { force: true });  // also remove indexed children

Options

FieldDefaultNotes
forcefalseIf the snapshot has indexed children (other snapshots derived from it), remove them too. Without force, removal of a parent with children throws.