Interface RemoveOptions

interface RemoveOptions {
    blobs?: boolean;
    dryRun?: boolean;
    ids: readonly string[];
    to?: string;
}

Properties

blobs?: boolean

Also remove the archived documents of these records that no remaining record refers to.

dryRun?: boolean

Say what would be removed, and change nothing.

ids: readonly string[]

The records to remove; every one must exist, or nothing is removed.

to?: string

Move the files under this directory (records/, blobs/) instead of deleting them.