Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PublishOptions

Hierarchy

Index

Properties

allowOffline?: boolean

When offline, save the IPNS record to the the local datastore without broadcasting to the network instead of simply failing.

This option is not yet implemented in js-ipfs. See tracking issue [ipfs/js-ipfs#1997] (https://github.com/ipfs/js-ipfs/issues/1997).

key?: string

Name of the key to be used

lifetime?: string

Time duration of the record

resolve?: boolean

Resolve given path before publishing

signal?: AbortSignal

Can be provided to a function that starts a long running task, which will be aborted when signal is triggered.

timeout?: number

Can be provided to a function that starts a long running task, which will be aborted after provided timeout (in ms).

ttl?: string

Time duration this record should be cached

Generated using TypeDoc