diff --git a/building-blocks/autobase.md b/building-blocks/autobase.md index 2f45849..4044af7 100644 --- a/building-blocks/autobase.md +++ b/building-blocks/autobase.md @@ -17,32 +17,32 @@ Notable features include: - [Create a new instance](autobase.md#installation) - Basic: - Properties: - - [base.inputs](autobase.md#baseinputs) - - [base.outputs](autobase.md#baseoutputs) - - [base.localInput](autobase.md#baselocalinput) - - [base.localOutput](autobase.md#baselocaloutput) + - [base.inputs](autobase.md#base.inputs) + - [base.outputs](autobase.md#base.outputs) + - [base.localInput](autobase.md#base.localinput) + - [base.localOutput](autobase.md#base.localoutput) - Methods: - - [base.clock()](autobase.md#const-clock--baseclock) - - [base.isAutobase(core)](autobase.md#await-autobaseisautobasecore) - - [base.append(value, [clock], [input])](autobase.md#await-baseappendvalue-clock-input) - - [base.latest([input1, input2, ...])](autobase.md#const-clock--await-baselatestinput1-input2) - - [base.addInput(input)](autobase.md#await-baseaddinputinput) - - [base.removeInput(input)](autobase.md#await-baseremoveinputinput) - - [base.addOutput(output)](autobase.md#await-baseaddoutputoutput) - - [base.removeOutput(output)](autobase.md#await-baseremoveoutputoutput) + - [base.clock()](autobase.md#const-clock-base.clock) + - [base.isAutobase(core)](autobase.md#await-autobase.isautobase-core) + - [base.append(value, [clock], [input])](autobase.md#await-base.append-value-clock-input) + - [base.latest([input1, input2, ...])](autobase.md#const-clock-await-base.latest-input1-input2) + - [base.addInput(input)](autobase.md#await-base.addinput-input) + - [base.removeInput(input)](autobase.md#await-base.removeinput-input) + - [base.addOutput(output)](autobase.md#await-base.addoutput-output) + - [base.removeOutput(output)](autobase.md#await-base.removeoutput-output) - Streams: - Methods: - - [base.createCausalStream()](autobase.md#const-stream--basecreatecausalstream) - - [base.createReadStream([options])](autobase.md#const-stream--basecreatereadstreamoptions) + - [base.createCausalStream()](autobase.md#const-stream-base.createcausalstream) + - [base.createReadStream([options])](autobase.md#const-stream-base.createreadstream-options) - Linearized Views: - Properties: - - [view.status](autobase.md#viewstatus) - - [view.length](autobase.md#viewlength) + - [view.status](autobase.md#view.status) + - [view.length](autobase.md#view.length) - Methods: - - [base.start({ apply, unwrap } = {})](autobase.md#basestart-apply-unwrap) - - [view.update()](autobase.md#await-viewupdate) - - [view.get(idx, [options])](autobase.md#const-entry--await-viewgetidx-options) - - [view.append([blocks])](autobase.md#await-viewappendblocks) + - [base.start({ apply, unwrap } = {})](autobase.md#base.start-apply-unwrap) + - [view.update()](autobase.md#await-view.update) + - [view.get(idx, [options])](autobase.md#const-entry-await-view.get-idx-options) + - [view.append([blocks])](autobase.md#await-view.append-blocks) ### Installation diff --git a/building-blocks/hyperdrive.md b/building-blocks/hyperdrive.md index de006ec..81789e9 100644 --- a/building-blocks/hyperdrive.md +++ b/building-blocks/hyperdrive.md @@ -19,43 +19,43 @@ Notable features include: * [drive.core](hyperdrive.md#drivecore) * [drive.id](hyperdrive.md#driveid) * [drive.key](hyperdrive.md#drivekey) - * [drive.writable](hyperdrive.md#drivewritable) - * [drive.readable](hyperdrive.md#drivereadable) - * [drive.discoveryKey](hyperdrive.md#drivediscoverykey) - * [drive.contentKey](hyperdrive.md#drivecontentkey) - * [drive.version](hyperdrive.md#driveversion) - * [drive.supportsMetadata](hyperdrive.md#drivesupportsmetadata) + * [drive.writable](hyperdrive.md#drive.writable) + * [drive.readable](hyperdrive.md#drive.readable) + * [drive.discoveryKey](hyperdrive.md#drive.discoverykey) + * [drive.contentKey](hyperdrive.md#drive.contentkey) + * [drive.version](hyperdrive.md#drive.version) + * [drive.supportsMetadata](hyperdrive.md#drive.supportsmetadata) * Methods: - * [drive.ready()](hyperdrive.md#await-driveready) - * [drive.close()](hyperdrive.md#await-driveclose) - * [drive.put(path, buffer, \[options\])](hyperdrive.md#await-driveputpath-buffer-options) - * [drive.get(path, \[options\])](hyperdrive.md#const-buffer--await-drivegetpath-options) - * [drive.entry(path, \[options\])](hyperdrive.md#const-entry--await-driveentrypath-options) - * [drive.exists(path)](hyperdrive.md#const-exists--await-driveexistspath) - * [drive.del(path)](hyperdrive.md#await-drivedelpath) - * [drive.compare(entryA, entryB)](hyperdrive.md#const-comparison--drivecompareentrya-entryb) - * [drive.clear(path, \[options\])](hyperdrive.md#const-cleared--await-driveclearpath-options) - * [drive.clearAll(\[options\])](hyperdrive.md#const-cleared--await-driveclearalloptions) - * [drive.purge()](hyperdrive.md#await-drivepurge) - * [drive.symlink(path, linkname)](hyperdrive.md#await-drivesymlinkpath-linkname) - * [drive.batch()](hyperdrive.md#const-batch--drivebatch) - * [batch.flush()](hyperdrive.md#await-batchflush) - * [drive.list(folder, \[options\])](hyperdrive.md#const-stream--drivelistfolder-options) - * [drive.readdir(folder)](hyperdrive.md#const-stream--drivereaddirfolder) - * [drive.entries(\[range\], \[options\])](hyperdrive.md#const-stream--await-driveentriesrange-options) - * [drive.mirror(out, \[options\])](hyperdrive.md#const-mirror--drivemirrorout-options) - * [drive.watch(\[folder\])](hyperdrive.md#const-watcher--drivewatchfolder) - * [drive.createReadStream(path, \[options\])](hyperdrive.md#const-rs--drivecreatereadstreampath-options) - * [drive.createWriteStream(path, \[options\])](hyperdrive.md#const-ws--drivecreatewritestreampath-options) - * [drive.download(folder, \[options\])](hyperdrive.md#await-drivedownloadfolder-options) - * [drive.checkout(version)](hyperdrive.md#const-snapshot--drivecheckoutversion) - * [drive.diff(version, folder, \[options\])](hyperdrive.md#await-drivedownloaddiffversion-folder-options) - * [drive.downloadDiff(version, folder, \[options\])](hyperdrive.md#await-drivedownloaddiffversion-folder-options) - * [drive.downloadRange(dbRanges, blobRanges)](hyperdrive.md#await-drivedownloadrangedbranges-blobranges) - * [drive.findingPeers()](hyperdrive.md#const-done--drivefindingpeers) - * [drive.replicate(isInitiatorOrStream)](hyperdrive.md#const-stream--drivereplicateisinitiatororstream) - * [drive.update(\[options\])](hyperdrive.md#const-updated--await-driveupdateoptions) - * [drive.getBlobs()](hyperdrive.md#const-blobs--await-drivegetblobs) + * [drive.ready()](hyperdrive.md#await-drive.ready) + * [drive.close()](hyperdrive.md#await-drive.close) + * [drive.put(path, buffer, \[options\])](hyperdrive.md#await-drive.put-path-buffer-options) + * [drive.get(path, \[options\])](hyperdrive.md#const-buffer--await-drive.get.path-options) + * [drive.entry(path, \[options\])](hyperdrive.md#const-entry--await-drive.entry-path-options) + * [drive.exists(path)](hyperdrive.md#const-exists--await-drive.exists-path) + * [drive.del(path)](hyperdrive.md#await-drive.del-path) + * [drive.compare(entryA, entryB)](hyperdrive.md#const-comparison--drive.compare-entrya-entryb) + * [drive.clear(path, \[options\])](hyperdrive.md#const-cleared--await-drive.clear-path-options) + * [drive.clearAll(\[options\])](hyperdrive.md#const-cleared--await-drive.clearall-options) + * [drive.purge()](hyperdrive.md#await-drive.purge) + * [drive.symlink(path, linkname)](hyperdrive.md#await-drive.symlink-path-linkname) + * [drive.batch()](hyperdrive.md#const-batch--drive.batch) + * [batch.flush()](hyperdrive.md#await-batch.flush) + * [drive.list(folder, \[options\])](hyperdrive.md#const-stream--drive.list-folder-options) + * [drive.readdir(folder)](hyperdrive.md#const-stream--drive.readdir-folder) + * [drive.entries(\[range\], \[options\])](hyperdrive.md#const-stream--await-drive.entries-range-options) + * [drive.mirror(out, \[options\])](hyperdrive.md#const-mirror--drive.mirror-out-options) + * [drive.watch(\[folder\])](hyperdrive.md#const-watcher--drive.watch-folder) + * [drive.createReadStream(path, \[options\])](hyperdrive.md#const-rs--drive.createreadstream-path-options) + * [drive.createWriteStream(path, \[options\])](hyperdrive.md#const-ws--drive.createwritestream-path-options) + * [drive.download(folder, \[options\])](hyperdrive.md#await-drive.download-folder-options) + * [drive.checkout(version)](hyperdrive.md#const-snapshot--drive.checkout-version) + * [drive.diff(version, folder, \[options\])](hyperdrive.md#await-drive.downloaddiff-version-folder-options) + * [drive.downloadDiff(version, folder, \[options\])](hyperdrive.md#await-drive.downloaddiff-version-folder-options) + * [drive.downloadRange(dbRanges, blobRanges)](hyperdrive.md#await-drive.downloadrange-dbranges-blobranges) + * [drive.findingPeers()](hyperdrive.md#const-done--drive.findingpeers) + * [drive.replicate(isInitiatorOrStream)](hyperdrive.md#const-stream--drive.replicate-isinitiatororstream) + * [drive.update(\[options\])](hyperdrive.md#const-updated--await-drive.update-options) + * [drive.getBlobs()](hyperdrive.md#const-blobs--await-drive.getblobs) ### Installation