Interface TouchOptions

Options to pass to the touch command

interface TouchOptions {
    mtime?: Mtime;
    offline?: boolean;
    onProgress?: (evt: PutBlockProgressEvents | GetEvents) => void;
    path?: string;
    recursive?: boolean;
    signal?: AbortSignal;
}

Hierarchy

AbortOptions
ProgressOptions<GetEvents | PutBlockProgressEvents>
- TouchOptions

Index

Properties

mtime? offline? onProgress? path? recursive? signal?

Properties

`Optional`mtime

mtime?: Mtime

Optional mtime to set on the DAG root, defaults to the current time

`Optional`offline

offline?: boolean

If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

`Optional`onProgress

onProgress?: (evt: PutBlockProgressEvents | GetEvents) => void

`Optional`path

path?: string

Optional path to set mtime on directory contents

`Optional`recursive

recursive?: boolean

If the DAG is a directory and this is true, update the mtime on all contents

`Optional`signal

signal?: AbortSignal