fixed building tools and helpers indexes

holepunchto · Feb 28, 2024 · 0ba49c6 · 0ba49c6
1 parent 924e1fa
commit 0ba49c6
Show file tree

Hide file tree

Showing 9 changed files with 187 additions and 187 deletions.
diff --git 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/hyperbee.md b/building-blocks/hyperbee.md
@@ -10,38 +10,38 @@ Hyperbee is an append only B-tree based on [`Hypercore`](hypercore.md). It provi
   * [Create a new instance](hyperbee.md#installation):
   * Basic:
     * Properties:
-      * [db.core](./hyperbee.md#dbcore)
-      * [db.version](./hyperbee.md#dbversion)
-      * [db.id](./hyperbee.md#dbid)
-      * [db.key](./hyperbee.md#dbkey)
-      * [db.discoveryKey](./hyperbee.md#dbdiscoverykey)
-      * [db.writable](./hyperbee.md#dbwritable)
-      * [db.readable](./hyperbee.md#dbreadable)
+      * [db.core](./hyperbee.md#db.core)
+      * [db.version](./hyperbee.md#db.version)
+      * [db.id](./hyperbee.md#db.id)
+      * [db.key](./hyperbee.md#db.key)
+      * [db.discoveryKey](./hyperbee.md#db.discoverykey)
+      * [db.writable](./hyperbee.md#db.writable)
+      * [db.readable](./hyperbee.md#db.readable)
     * Methods:
-      * [db.ready()](hyperbee.md#await-dbready)
-      * [db.close()](hyperbee.md#await-dbclose)
-      * [db.put(key, \[value\], \[options\])](hyperbee.md#await-dbputkey-value-options)
-      * [db.get(key, \[options\])](hyperbee.md#const--seq-key-value---await-dbgetkey-options)
-      * [db.del(key, \[options\])](hyperbee.md#await-dbdelkey-options)
-      * [db.getBySeq(seq, \[options\])](hyperbee.md#const--key-value---await-dbgetbyseqseq-options)
-      * [db.replicate(isInitiatorOrStream)](hyperbee.md#const-stream--dbreplicateisinitiatororstream)
-      * [db.batch()](hyperbee.md#const-batch--dbbatch)
-        * [batch.put(key, \[value\], \[options\])](hyperbee.md#await-batchputkey-value-options)
-        * [batch.get(key, \[options\])](hyperbee.md#const--seq-key-value---await-batchgetkey-options)
-        * [batch.del(key, \[options\])](hyperbee.md#await-batchdelkey-options)
-        * [batch.flush()](hyperbee.md#await-batchflush)
-        * [batch.close()](hyperbee.md#await-batchclose)
-      * [db.createReadStream(\[range\], \[options\])](hyperbee.md#const-stream--dbcreatereadstreamrange-options)
-      * [db.peek(\[range\], \[options\])](hyperbee.md#const--seq-key-value---await-dbpeekrange-options)
-      * [db.createHistoryStream(\[options\])](hyperbee.md#const-stream--dbcreatehistorystreamoptions)
-      * [db.createDiffStream(otherVersion, \[options\])](hyperbee.md#const-stream--dbcreatediffstreamotherversion-options)
-      * [db.getAndWatch(key, \[options\])](hyperbee.md#const-entrywatcher--await-dbgetandwatchkey-options)
-      * [db.watch(\[range\])](hyperbee.md#const-watcher--dbwatchrange)
-      * [db.checkout(version)](hyperbee.md#const-snapshot--dbcheckoutversion)
-      * [db.snapshot()](hyperbee.md#const-snapshot--dbsnapshot)
-      * [db.sub('sub-prefix', \[options\])](hyperbee.md#const-sub--dbsubsub-prefix-optionss)
-      * [db.getHeader(\[options\])](hyperbee.md#const-header--await-dbgetheaderoptions)
-      * [Hyperbee.isHyperbee(core, \[options\])](hyperbee.md#const-ishyperbee--await-hyperbeeishyperbeecore-options)
+      * [db.ready()](hyperbee.md#await-db.ready)
+      * [db.close()](hyperbee.md#await-db.close)
+      * [db.put(key, \[value\], \[options\])](hyperbee.md#await-db.put-key-value-options)
+      * [db.get(key, \[options\])](hyperbee.md#const-seq-key-value--await-db.get-key-options)
+      * [db.del(key, \[options\])](hyperbee.md#await-db.del-key-options)
+      * [db.getBySeq(seq, \[options\])](hyperbee.md#const-key-value-await-db.getbyseq-seq-options)
+      * [db.replicate(isInitiatorOrStream)](hyperbee.md#const-stream--db.replicate-isinitiatororstream)
+      * [db.batch()](hyperbee.md#const-batch-db.batch)
+        * [batch.put(key, \[value\], \[options\])](hyperbee.md#await-batch.put-key-value-options)
+        * [batch.get(key, \[options\])](hyperbee.md#const-seq-key-value-await-batch.get-key-options)
+        * [batch.del(key, \[options\])](hyperbee.md#await-batch.del-key-options)
+        * [batch.flush()](hyperbee.md#await-batch.flush)
+        * [batch.close()](hyperbee.md#await-batch.close)
+      * [db.createReadStream(\[range\], \[options\])](hyperbee.md#const-stream-db.createreadstream-range-options)
+      * [db.peek(\[range\], \[options\])](hyperbee.md#const-seq-key-value-await-db.peek-range-options)
+      * [db.createHistoryStream(\[options\])](hyperbee.md#const-stream--db.createhistorystream-options)
+      * [db.createDiffStream(otherVersion, \[options\])](hyperbee.md#const-stream-db.creatediffstream-otherversion-options)
+      * [db.getAndWatch(key, \[options\])](hyperbee.md#const-entrywatcher-await-db.getandwatch-key-options)
+      * [db.watch(\[range\])](hyperbee.md#const-watcher-db-watch-range)
+      * [db.checkout(version)](hyperbee.md#const-snapshot-db.checkout-version)
+      * [db.snapshot()](hyperbee.md#const-snapshot-db.snapshot)
+      * [db.sub('sub-prefix', \[options\])](hyperbee.md#const-sub-db.sub-sub-prefix-optionss)
+      * [db.getHeader(\[options\])](hyperbee.md#const-header-await-db.getheader-options)
+      * [Hyperbee.isHyperbee(core, \[options\])](hyperbee.md#const-ishyperbee-await-hyperbee.ishyperbee-core-options)
 
 ### Installation
 

diff --git a/building-blocks/hypercore.md b/building-blocks/hypercore.md
@@ -16,45 +16,45 @@ Notable features include:
   * [Creating a new instance](hypercore.md#installation)
   * Basic:
     * Properties:
-      * [core.writable](hypercore.md#corewritable)
-      * [core.readable](hypercore.md#corereadable)
-      * [core.id](hypercore.md#coreid)
-      * [core.key](hypercore.md#corekey)
-      * [core.keyPair](hypercore.md#corekeypair)
-      * [core.discoveryKey](hypercore.md#corediscoverykey)
-      * [core.encryptionKey](hypercore.md#coreencryptionkey)
-      * [core.length](hypercore.md#corelength)
-      * [core.contiguousLength](hypercore.md#corecontiguouslength)
-      * [core.fork](hypercore.md#corefork)
-      * [core.padding](hypercore.md#corepadding)
+      * [core.writable](hypercore.md#core.writable)
+      * [core.readable](hypercore.md#core.readable)
+      * [core.id](hypercore.md#core.id)
+      * [core.key](hypercore.md#core.key)
+      * [core.keyPair](hypercore.md#core.keypair)
+      * [core.discoveryKey](hypercore.md#core.discoverykey)
+      * [core.encryptionKey](hypercore.md#core.encryptionkey)
+      * [core.length](hypercore.md#core.length)
+      * [core.contiguousLength](hypercore.md#core.contiguouslength)
+      * [core.fork](hypercore.md#core.fork)
+      * [core.padding](hypercore.md#core.padding)
     * Methods:
-      * [core.append(block)](hypercore.md#const--length-bytelength---await-coreappendblock)
-      * [core.get(index, \[options\])](hypercore.md#const-block--await-coregetindex-options)
-      * [core.has(start, \[end\])](hypercore.md#const-has--await-corehasstart-end)
-      * [core.update()](hypercore.md#const-updated--await-coreupdateoptions)
-      * [core.seek(byteOffset)](hypercore.md#const-index-relativeoffset--await-coreseekbyteoffset-options)
-      * [core.createReadStream(\[options\])](hypercore.md#const-stream--corecreatereadstreamoptions)
-      * [core.createByteStream(\[options\])](hypercore.md#const-stream--corecreatereadstreamoptions)
-      * [core.clear(start, \[end\], \[options\])](hypercore.md#const-cleared--await-coreclearstart-end-options)
-      * [core.truncate(newLength, \[forkId\])](hypercore.md#await-coretruncatenewlength-forkid)
-      * [core.purge()](hypercore.md#await-corepurge)
-      * [core.treeHash(\[length\])](hypercore.md#const-hash--await-coretreehashlength)
-      * [core.download(\[range\])](hypercore.md#const-range--coredownloadrange)
-      * [core.session(\[options\])](hypercore.md#const-session--await-coresessionoptions)
-      * [core.info(\[options\])](hypercore.md#const-info--await-coreinfooptions)
-      * [core.close()](hypercore.md#await-coreclose)
-      * [core.ready()](hypercore.md#await-coreready)
-      * [core.replicate(isInitiatorOrReplicationStream, \[options\])](hypercore.md#const-stream--corereplicateisinitiatorstream-options)
-      * [core.findingPeers()](hypercore.md#const-done--corefindingpeers)
-      * [core.session(\[options\])](hypercore.md#coresessionoptions)
-      * [core.snapshot(\[options\])](hypercore.md#coresnapshotoptions)
+      * [core.append(block)](hypercore.md#const-length-bytelength-await-core.append-block)
+      * [core.get(index, \[options\])](hypercore.md#const-block-await-core.get-index-options)
+      * [core.has(start, \[end\])](hypercore.md#const-has-await-core.has-start-end)
+      * [core.update()](hypercore.md#const-updated-await-core.update-options)
+      * [core.seek(byteOffset)](hypercore.md#const-index-relativeoffset-await-core.seek-byteoffset-options)
+      * [core.createReadStream(\[options\])](hypercore.md#const-stream-core.createreadstream-options)
+      * [core.createByteStream(\[options\])](hypercore.md#const-bs-core.createbytestream-options)
+      * [core.clear(start, \[end\], \[options\])](hypercore.md#const-cleared-await-core.clear-start-end-options)
+      * [core.truncate(newLength, \[forkId\])](hypercore.md#await-core.truncate-newlength-forkid)
+      * [core.purge()](hypercore.md#await-core.purge)
+      * [core.treeHash(\[length\])](hypercore.md#const-hash-await-core.treehash-length)
+      * [core.download(\[range\])](hypercore.md#const-range-core.download-range)
+      * [core.session(\[options\])](hypercore.md#const-session-await-core.session-options)
+      * [core.info(\[options\])](hypercore.md#const-info-await-core.info-options)
+      * [core.close()](hypercore.md#await-core.close)
+      * [core.ready()](hypercore.md#await-core.ready)
+      * [core.replicate(isInitiatorOrReplicationStream, \[options\])](hypercore.md#const-stream-core.replicate-isinitiator-or-stream-options)
+      * [core.findingPeers()](hypercore.md#const-done-core.findingpeers)
+      * [core.session(\[options\])](hypercore.md#core.session-options)
+      * [core.snapshot(\[options\])](hypercore.md#core.snapshot-options)
     * Events:
-      * [append](hypercore.md#coreonappend)
-      * [truncate](hypercore.md#coreontruncate-ancestors-forkid)
-      * [ready](hypercore.md#coreonready)
-      * [close](hypercore.md#coreonclose)
-      * [peer-add](hypercore.md#coreonpeer-add)
-      * [peer-remove](hypercore.md#coreonpeer-remove)
+      * [append](hypercore.md#core.on-append)
+      * [truncate](hypercore.md#core.on-truncate-ancestors-forkid)
+      * [ready](hypercore.md#core.on-ready)
+      * [close](hypercore.md#core.on-close)
+      * [peer-add](hypercore.md#core.on-peer-add)
+      * [peer-remove](hypercore.md#core.on-peer-remove)
 
 ### Installation
 

diff --git a/building-blocks/hyperdht.md b/building-blocks/hyperdht.md
@@ -14,38 +14,38 @@ Notable features include:
   * [Create a new instance](hyperdht.md#installation)
   * Basic:
     * Methods:
-      * [DHT.keyPair(\[seed\])](hyperdht.md#keypair--dhtkeypairseed)
-      * [DHT.bootstrapper(port, host, \[options\])](hyperdht.md#node--dhtbootstrapperport-host-options)
-      * [node.destroy(\[options\])](hyperdht.md#await-nodedestroyoptions)
+      * [DHT.keyPair(\[seed\])](hyperdht.md#keypair-dht.keypair-seed)
+      * [DHT.bootstrapper(port, host, \[options\])](hyperdht.md#node-dhtbootstrapper.port-host-options)
+      * [node.destroy(\[options\])](hyperdht.md#await-node-destroy-options)
     * [Creating P2P servers:](hyperdht.md#creating-p2p-servers)
-      * [node.createServer(\[options\], \[onconnection\])](hyperdht.md#const-server--nodecreateserveroptions-onconnection)
+      * [node.createServer(\[options\], \[onconnection\])](hyperdht.md#const-server-node.createserver-options-onconnection)
       * Methods:
-        * [server.listen(keyPair)](hyperdht.md#await-serverlistenkeypair)
-        * [server.refresh()](hyperdht.md#serverrefresh)
-        * [server.address()](hyperdht.md#serveraddress)
-        * [server.close()](hyperdht.md#await-serverclose)
+        * [server.listen(keyPair)](hyperdht.md#await-server.listen-keypair)
+        * [server.refresh()](hyperdht.md#server.refresh)
+        * [server.address()](hyperdht.md#server.address)
+        * [server.close()](hyperdht.md#await-server.close)
       * Events:
-        * [connection](hyperdht.md#serveronconnection-socket)
-        * [listening](hyperdht.md#serveronlistening)
-        * [close](hyperdht.md#serveronclose)
+        * [connection](hyperdht.md#server.on-connection-socket)
+        * [listening](hyperdht.md#server.on-listening)
+        * [close](hyperdht.md#server.on-close)
     * [Connecting to P2P servers](hyperdht.md#connecting-to-p2p-servers):
-      * [node.connect(remotePublicKey, \[options\])](hyperdht.md#const-socket--nodeconnectremotepublickey-options)
+      * [node.connect(remotePublicKey, \[options\])](hyperdht.md#const-socket-node.connect-remotepublickey-options)
       * Properties:
-        * [socket.remotePublicKey](hyperdht.md#socketremotepublickey)
-        * [socket.publicKey](hyperdht.md#socketpublickey)
+        * [socket.remotePublicKey](hyperdht.md#socket.remotepublickey)
+        * [socket.publicKey](hyperdht.md#socket.publickey)
       * Events:
-        * [open](hyperdht.md#socketonopen)
+        * [open](hyperdht.md#socket.on-open)
     * [Additional Peer Discovery](hyperdht.md#additional-peer-discovery):
       * Methods:
-        * [node.lookup(topic, \[options\])](hyperdht.md#const-stream--nodelookuptopic-options)
-        * [node.announce(topic, keyPair, \[relayAddresses\], \[options\])](hyperdht.md#const-stream--nodeannouncetopic-keypair-relayaddresses-options)
-        * [node.unannounce(topic, keyPair, \[options\])](hyperdht.md#await-nodeunannouncetopic-keypair-options)
-  * [Mutable/immutable records:](hyperdht.md#mutableimmutable-records)
+        * [node.lookup(topic, \[options\])](hyperdht.md#const-stream--node.lookup-topic-options)
+        * [node.announce(topic, keyPair, \[relayAddresses\], \[options\])](hyperdht.md#const-stream-node.announce-topic-keypair-relayaddresses-options)
+        * [node.unannounce(topic, keyPair, \[options\])](hyperdht.md#await-node.unannounce-topic-keypair-options)
+  * [Mutable/immutable records:](hyperdht.md#mutable-immutable-records)
     * Methods:
-      * [node.immutablePut(value, \[options\])](hyperdht.md#const--hash-closestnodes---await-nodeimmutableputvalue-options)
-      * [node.immutableGet(hash, \[options\])](hyperdht.md#const--value-from---await-nodeimmutablegethash-options)
-      * [node.mutablePut(keyPair, value, \[options\])](hyperdht.md#const--publickey-closestnodes-seq-signature---await-nodemutableputkeypair-value-options)
-      * [node.mutableGet(publicKey, \[options\])](hyperdht.md#const--value-from-seq-signature---await-nodemutablegetpublickey-options)
+      * [node.immutablePut(value, \[options\])](hyperdht.md#const-hash-closestnodes-await-node.immutableput-value-options)
+      * [node.immutableGet(hash, \[options\])](hyperdht.md#const--value-from---await-node.immutableget-hash-options)
+      * [node.mutablePut(keyPair, value, \[options\])](hyperdht.md#const--publickey-closestnodes-seq-signature-await-node.mutableput-keypair-value-options)
+      * [node.mutableGet(publicKey, \[options\])](hyperdht.md#const--value-from-seq-signature-await-node.mutableget-publickey-options)
 
 ### Installation