git ssb

0+

wanderer🌟 / js-dfinity-radix-tree



Commit 6e08ac6c993a345adaacde9e320378116612b68b

rebuild docs

Signed-off-by: wanderer <mjbecze@gmail.com>
wanderer committed on 10/9/2017, 7:02:55 PM
Parent: f47aea5be452991650859d2af99234ea38e6efd4

Files changed

docs/index.mdchanged
docs/index.mdView
@@ -8,12 +8,13 @@
88 - [delete](#delete)
99 - [flush](#flush)
1010 - [emptyTreeState](#emptytreestate)
1111 - [ArrayConstructor](#arrayconstructor)
12 +- [getMerkleLink](#getmerklelink)
1213
1314 ## constructor
1415
15-[index.js:17-24](https://github.com/wanderer/js-dfinity-radix-tree/blob/24407d385e0f7cc8eed70abe5a5e927a092ebe60/index.js#L17-L24 "Source code on GitHub")
16 +[index.js:17-24](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L17-L24 "Source code on GitHub")
1617
1718 **Parameters**
1819
1920 - `opts`
@@ -23,9 +24,9 @@
2324 - `opts.dag` {object} an instance if [ipfs.dag](https://github.com/ipfs/js-ipfs#dag). If there is no `opts.graph` this will be used to create a new graph instance.
2425
2526 ## get
2627
27-[index.js:102-106](https://github.com/wanderer/js-dfinity-radix-tree/blob/24407d385e0f7cc8eed70abe5a5e927a092ebe60/index.js#L102-L106 "Source code on GitHub")
28 +[index.js:111-115](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L111-L115 "Source code on GitHub")
2829
2930 gets a value given a key
3031
3132 **Parameters**
@@ -35,9 +36,9 @@
3536 Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
3637
3738 ## set
3839
39-[index.js:113-149](https://github.com/wanderer/js-dfinity-radix-tree/blob/24407d385e0f7cc8eed70abe5a5e927a092ebe60/index.js#L113-L149 "Source code on GitHub")
40 +[index.js:122-158](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L122-L158 "Source code on GitHub")
4041
4142 stores a value at a given key
4243
4344 **Parameters**
@@ -48,9 +49,9 @@
4849 Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
4950
5051 ## delete
5152
52-[index.js:156-208](https://github.com/wanderer/js-dfinity-radix-tree/blob/24407d385e0f7cc8eed70abe5a5e927a092ebe60/index.js#L156-L208 "Source code on GitHub")
53 +[index.js:165-217](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L165-L217 "Source code on GitHub")
5354
5455 deletes a value at a given key
5556
5657 **Parameters**
@@ -60,23 +61,35 @@
6061 Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
6162
6263 ## flush
6364
64-[index.js:214-216](https://github.com/wanderer/js-dfinity-radix-tree/blob/24407d385e0f7cc8eed70abe5a5e927a092ebe60/index.js#L214-L216 "Source code on GitHub")
65 +[index.js:223-225](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L223-L225 "Source code on GitHub")
6566
6667 creates a merkle root for the current tree and stores the data perstantly
6768
6869 Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
6970
7071 ## emptyTreeState
7172
72-[index.js:29-31](https://github.com/wanderer/js-dfinity-radix-tree/blob/24407d385e0f7cc8eed70abe5a5e927a092ebe60/index.js#L29-L31 "Source code on GitHub")
73 +[index.js:29-31](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L29-L31 "Source code on GitHub")
7374
7475 returns the state of an empty tree
7576
7677 ## ArrayConstructor
7778
78-[index.js:37-39](https://github.com/wanderer/js-dfinity-radix-tree/blob/24407d385e0f7cc8eed70abe5a5e927a092ebe60/index.js#L37-L39 "Source code on GitHub")
79 +[index.js:37-39](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L37-L39 "Source code on GitHub")
7980
8081 returns an Uint1Array constructir which is used to repersent keys
8182
8283 Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
84 +
85 +## getMerkleLink
86 +
87 +[index.js:46-48](https://github.com/dfinity/js-dfinity-radix-tree/blob/878e413eb6f1500a2c9f5c2fbe58014339f7652b/index.js#L46-L48 "Source code on GitHub")
88 +
89 +returns a merkle link for some given data
90 +
91 +**Parameters**
92 +
93 +- `data` **[Buffer](https://nodejs.org/api/buffer.html)** the data which you would like to hash
94 +
95 +Returns **[Buffer](https://nodejs.org/api/buffer.html)**

Built with git-ssb-web