Interface StatOptions

Options to pass to the stat command

interface StatOptions {
    offline?: boolean;
    onProgress?: ((evt) => void);
    path?: string;
    signal?: AbortSignal;
}

Hierarchy

AbortOptions
ProgressOptions<GetEvents>
- StatOptions

Index

Properties

offline? onProgress? path? signal?

Properties

`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
  - evt: GetEvents
  Returns void

`Optional` path

path?: string

An optional path to allow statting paths inside directories

`Optional` signal

signal?: AbortSignal