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.md | changed |
docs/index.md | ||
---|---|---|
@@ -8,12 +8,13 @@ | ||
8 | 8 … | - [delete](#delete) |
9 | 9 … | - [flush](#flush) |
10 | 10 … | - [emptyTreeState](#emptytreestate) |
11 | 11 … | - [ArrayConstructor](#arrayconstructor) |
12 … | +- [getMerkleLink](#getmerklelink) | |
12 | 13 … | |
13 | 14 … | ## constructor |
14 | 15 … | |
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") | |
16 | 17 … | |
17 | 18 … | **Parameters** |
18 | 19 … | |
19 | 20 … | - `opts` |
@@ -23,9 +24,9 @@ | ||
23 | 24 … | - `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. |
24 | 25 … | |
25 | 26 … | ## get |
26 | 27 … | |
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") | |
28 | 29 … | |
29 | 30 … | gets a value given a key |
30 | 31 … | |
31 | 32 … | **Parameters** |
@@ -35,9 +36,9 @@ | ||
35 | 36 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** |
36 | 37 … | |
37 | 38 … | ## set |
38 | 39 … | |
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") | |
40 | 41 … | |
41 | 42 … | stores a value at a given key |
42 | 43 … | |
43 | 44 … | **Parameters** |
@@ -48,9 +49,9 @@ | ||
48 | 49 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** |
49 | 50 … | |
50 | 51 … | ## delete |
51 | 52 … | |
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") | |
53 | 54 … | |
54 | 55 … | deletes a value at a given key |
55 | 56 … | |
56 | 57 … | **Parameters** |
@@ -60,23 +61,35 @@ | ||
60 | 61 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** |
61 | 62 … | |
62 | 63 … | ## flush |
63 | 64 … | |
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") | |
65 | 66 … | |
66 | 67 … | creates a merkle root for the current tree and stores the data perstantly |
67 | 68 … | |
68 | 69 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** |
69 | 70 … | |
70 | 71 … | ## emptyTreeState |
71 | 72 … | |
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") | |
73 | 74 … | |
74 | 75 … | returns the state of an empty tree |
75 | 76 … | |
76 | 77 … | ## ArrayConstructor |
77 | 78 … | |
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") | |
79 | 80 … | |
80 | 81 … | returns an Uint1Array constructir which is used to repersent keys |
81 | 82 … | |
82 | 83 … | 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