Interface ExtendedStatOptions

Options to pass to the stat command

interface ExtendedStatOptions {
    extended: true;
    filter?: Filter;
    offline?: boolean;
    onProgress?: ((evt) => void);
    path?: string;
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

extended filter? offline? onProgress? path? signal?

Properties

extended

extended: true

If true, traverse the whole DAG to return additional stats. If all data is not in the local blockstore, this may involve fetching them from the network.

Optional filter

filter?: Filter

By default CIDs are deduplicated using a ScalableCuckooFilter - if you wish to use a different filter, pass it here.

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) => void)

Type declaration

    • (evt): void

    • Parameters

      Returns void

Optional path

path?: string

An optional path to allow getting stats of paths inside directories

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

extendedfilterofflineonProgresspathsignal