Skip to content

Minima.js API


Minima.js API / @minimajs/disk / plugins / checksum

Function: checksum()

ts
function checksum(options?): (disk) => void;

Checksum plugin — writes a sidecar hash file alongside each stored file and verifies integrity on stream read.

Calls driver methods directly (bypassing hooks) so the sidecar file is invisible to other plugins and cannot trigger recursive verification.

Parameters

options?

ChecksumOptions = {}

Returns

ts
(disk): void;

Parameters

disk

Disk

Returns

void

Example

ts
const disk = createDisk({ driver }, checksum())
await disk.put('data.json', content)    // writes data.json + data.json.sha256
const file = await disk.get('data.json') // stream verified on read