Interface API<OptionExtension>

Type parameters

OptionExtension = {}

Hierarchy

API

Index

Methods

Methods

gc

gc(options?: GCOptions & OptionExtension): AsyncIterable<GCResult>

- Defined in repo/index.ts:10
Perform garbage collection on the repo

Any unpinned blocks will be deleted

Parameters
- Optional options: GCOptions & OptionExtension
Returns AsyncIterable<GCResult>

stat

stat(options?: AbortOptions & OptionExtension): Promise<StatResult>

- Defined in repo/index.ts:15
Return stats about the repo

Parameters
- Optional options: AbortOptions & OptionExtension
Returns Promise<StatResult>

version

version(options?: AbortOptions & OptionExtension): Promise<number>

- Defined in repo/index.ts:21
If the repo has been initialized, report the current version, otherwise report the version that would be initialized

Parameters
- Optional options: AbortOptions & OptionExtension
Returns Promise<number>

Generated using TypeDoc