Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/willow/mod.browser.ts>PayloadDriver

Exploring Willow in the most efficient and sound programming language
Go to Latest
interface PayloadDriver
Re-export
import { type PayloadDriver } from "https://deno.land/x/willow@0.2.1/mod.browser.ts";

Provides methods for storing and retrieving Payloads.

Type Parameters

PayloadDigest

Methods

get(payloadHash: PayloadDigest): Promise<Payload | undefined>

Returns a payload for a given format and hash.

set(payload: Uint8Array | AsyncIterable<Uint8Array>): Promise<{ digest: PayloadDigest; length: bigint; payload: Payload; }>

Stores a complete payload with an unknown digest, intended for a new entry.

receive(opts: { payload: Uint8Array | AsyncIterable<Uint8Array>; offset: number; knownLength: bigint; knownDigest: PayloadDigest; }): Promise<{ digest: PayloadDigest; length: bigint; }>

Stores a possibly partial payload with an known digest, intended for an existing entry.

length(payloadHash: PayloadDigest): Promise<bigint>

Get the length of a stored payload

erase(digest: PayloadDigest): Promise<true | ValidationError>

Erases an payload for a given format and hash.