Interface PublishOptions

interface PublishOptions {
    lifetime?: number;
    offline?: boolean;
    onProgress?: (
        evt: IPNSRoutingProgressEvents | PublishProgressEvents,
    ) => void;
    signal?: AbortSignal;
    ttl?: number;
    v1Compatible?: boolean;
}

Hierarchy

AbortOptions
ProgressOptions<PublishProgressEvents | IPNSRoutingProgressEvents>
- PublishOptions

Index

Properties

lifetime? offline? onProgress? signal? ttl? v1Compatible?

Properties

`Optional`lifetime

lifetime?: number

Time duration of the signature validity in ms (default: 48hrs)

`Optional`offline

offline?: boolean

Only publish to a local datastore (default: false)

`Optional`onProgress

onProgress?: (evt: IPNSRoutingProgressEvents | PublishProgressEvents) => void

`Optional`signal

signal?: AbortSignal

`Optional`ttl

ttl?: number

The TTL of the record in ms (default: 5 minutes)

`Optional`v1Compatible

v1Compatible?: boolean

By default a IPNS V1 and a V2 signature is added to every record. Pass false here to only add a V2 signature. (default: true)