API index
Every documented primitive, grouped by namespace page - 19 primitives. Generated from the same source comments that build the rest of this site.
Backends
| Primitive | Since | Status |
|---|---|---|
new DiskBackend(opts) -> DiskBackend | 0.1.1 | stable |
new MemoryBackend() -> MemoryBackend | 0.1.0 | stable |
Backend conformance
| Primitive | Since | Status |
|---|---|---|
runBackendConformance(factory, options) -> void | 0.1.16 | stable |
Stash
| Primitive | Since | Status |
|---|---|---|
new Stash(opts) -> Stash | 0.1.0 | stable |
stash.push(source, opts) -> Promise<string> | 0.1.0 | stable |
stash.apply(ref) -> Promise<Readable> | 0.1.0 | stable |
stash.pop(ref) -> Promise<Readable> | 0.1.7 | stable |
stash.store(entry, source) -> Promise<boolean> | 0.1.9 | stable |
stash.show(ref) -> Promise<Entry> | 0.1.0 | stable |
stash.has(ref) -> Promise<boolean> | 0.1.8 | stable |
stash.stats() -> Promise<{ entries, bytes, claimed }> | 0.1.8 | stable |
stash.tombstones() -> Promise<Tombstone[]> | 0.1.9 | stable |
stash.verify(opts?) -> Promise<Report> | 0.1.8 | stable |
stash.list(opts) -> Promise<Entry[]> | 0.1.0 | stable |
stash.reconcilable() -> Promise<{ entries: Entry[], corrupt: string[] }> | 0.1.15 | stable |
stash.drop(ref) -> Promise<boolean> | 0.1.0 | stable |
stash.clear() -> Promise<number> | 0.1.0 | stable |
stash.prune() -> Promise<number> | 0.1.5 | stable |
stash.close() -> Promise<void> | 0.1.5 | stable |