Commit 1b527623b342eaea09fb4ab9477003ed4d570ef3
build docs
wanderer committed on 8/4/2017, 11:11:13 PMParent: c05ecac437698d9d42b13f01e4931e3d7469affe
Files changed
| docs/index.md | changed |
| docs/index.md | |||
|---|---|---|---|
| @@ -11,9 +11,9 @@ | |||
| 11 | 11 … | - [toTypedArray](#totypedarray) | |
| 12 | 12 … | ||
| 13 | 13 … | ## constructor | |
| 14 | 14 … | ||
| 15 | -[index.js:19-22](https://github.com/wanderer/merkle-radix-tree/blob/bef8976f2a564cf623b6149280f7efe17f4a2886/index.js#L19-L22 "Source code on GitHub") | ||
| 15 … | +[index.js:20-23](https://github.com/wanderer/merkle-radix-tree/blob/c05ecac437698d9d42b13f01e4931e3d7469affe/index.js#L20-L23 "Source code on GitHub") | ||
| 16 | 16 … | ||
| 17 | 17 … | **Parameters** | |
| 18 | 18 … | ||
| 19 | 19 … | - `opts` | |
| @@ -22,9 +22,9 @@ | |||
| 22 | 22 … | - `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. | |
| 23 | 23 … | ||
| 24 | 24 … | ## get | |
| 25 | 25 … | ||
| 26 | -[index.js:111-115](https://github.com/wanderer/merkle-radix-tree/blob/bef8976f2a564cf623b6149280f7efe17f4a2886/index.js#L111-L115 "Source code on GitHub") | ||
| 26 … | +[index.js:112-116](https://github.com/wanderer/merkle-radix-tree/blob/c05ecac437698d9d42b13f01e4931e3d7469affe/index.js#L112-L116 "Source code on GitHub") | ||
| 27 | 27 … | ||
| 28 | 28 … | gets a value given a key | |
| 29 | 29 … | ||
| 30 | 30 … | **Parameters** | |
| @@ -34,9 +34,9 @@ | |||
| 34 | 34 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 35 | 35 … | ||
| 36 | 36 … | ## set | |
| 37 | 37 … | ||
| 38 | -[index.js:122-165](https://github.com/wanderer/merkle-radix-tree/blob/bef8976f2a564cf623b6149280f7efe17f4a2886/index.js#L122-L165 "Source code on GitHub") | ||
| 38 … | +[index.js:123-166](https://github.com/wanderer/merkle-radix-tree/blob/c05ecac437698d9d42b13f01e4931e3d7469affe/index.js#L123-L166 "Source code on GitHub") | ||
| 39 | 39 … | ||
| 40 | 40 … | stores a value at a given key | |
| 41 | 41 … | ||
| 42 | 42 … | **Parameters** | |
| @@ -47,9 +47,9 @@ | |||
| 47 | 47 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 48 | 48 … | ||
| 49 | 49 … | ## delete | |
| 50 | 50 … | ||
| 51 | -[index.js:172-223](https://github.com/wanderer/merkle-radix-tree/blob/bef8976f2a564cf623b6149280f7efe17f4a2886/index.js#L172-L223 "Source code on GitHub") | ||
| 51 … | +[index.js:173-224](https://github.com/wanderer/merkle-radix-tree/blob/c05ecac437698d9d42b13f01e4931e3d7469affe/index.js#L173-L224 "Source code on GitHub") | ||
| 52 | 52 … | ||
| 53 | 53 … | deletes a value at a given key | |
| 54 | 54 … | ||
| 55 | 55 … | **Parameters** | |
| @@ -59,25 +59,25 @@ | |||
| 59 | 59 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 60 | 60 … | ||
| 61 | 61 … | ## flush | |
| 62 | 62 … | ||
| 63 | -[index.js:229-231](https://github.com/wanderer/merkle-radix-tree/blob/bef8976f2a564cf623b6149280f7efe17f4a2886/index.js#L229-L231 "Source code on GitHub") | ||
| 63 … | +[index.js:230-232](https://github.com/wanderer/merkle-radix-tree/blob/c05ecac437698d9d42b13f01e4931e3d7469affe/index.js#L230-L232 "Source code on GitHub") | ||
| 64 | 64 … | ||
| 65 | 65 … | creates a merkle root for the current tree and stores the data perstantly | |
| 66 | 66 … | ||
| 67 | 67 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 68 | 68 … | ||
| 69 | 69 … | ## ArrayConstructor | |
| 70 | 70 … | ||
| 71 | -[index.js:28-30](https://github.com/wanderer/merkle-radix-tree/blob/bef8976f2a564cf623b6149280f7efe17f4a2886/index.js#L28-L30 "Source code on GitHub") | ||
| 71 … | +[index.js:29-31](https://github.com/wanderer/merkle-radix-tree/blob/c05ecac437698d9d42b13f01e4931e3d7469affe/index.js#L29-L31 "Source code on GitHub") | ||
| 72 | 72 … | ||
| 73 | 73 … | returns an Uint1Array constructir which is used to repersent keys | |
| 74 | 74 … | ||
| 75 | 75 … | Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
| 76 | 76 … | ||
| 77 | 77 … | ## toTypedArray | |
| 78 | 78 … | ||
| 79 | -[index.js:37-39](https://github.com/wanderer/merkle-radix-tree/blob/bef8976f2a564cf623b6149280f7efe17f4a2886/index.js#L37-L39 "Source code on GitHub") | ||
| 79 … | +[index.js:38-40](https://github.com/wanderer/merkle-radix-tree/blob/c05ecac437698d9d42b13f01e4931e3d7469affe/index.js#L38-L40 "Source code on GitHub") | ||
| 80 | 80 … | ||
| 81 | 81 … | converts a TypedArray or Buffer to an Uint1Array | |
| 82 | 82 … | ||
| 83 | 83 … | **Parameters** | |
Built with git-ssb-web