Commit d0317f4a7e4fa27b5149d817e90591e747a3f45d
rebuild docs
wanderer committed on 12/1/2017, 3:14:21 AMParent: ca8952130fa954fc6fad3847bdd48dd40fc3228f
Files changed
| docs/index.md | changed |
| docs/index.md | |||
|---|---|---|---|
| @@ -12,9 +12,9 @@ | |||
| 12 | 12 … | - [getMerkleLink](#getmerklelink) | |
| 13 | 13 … | ||
| 14 | 14 … | ## constructor | |
| 15 | 15 … | ||
| 16 | -[index.js:18-25](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L18-L25 "Source code on GitHub") | ||
| 16 … | +[index.js:18-26](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L18-L26 "Source code on GitHub") | ||
| 17 | 17 … | ||
| 18 | 18 … | **Parameters** | |
| 19 | 19 … | ||
| 20 | 20 … | - `opts` | |
| @@ -24,9 +24,9 @@ | |||
| 24 | 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. | |
| 25 | 25 … | ||
| 26 | 26 … | ## get | |
| 27 | 27 … | ||
| 28 | -[index.js:114-122](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L114-L122 "Source code on GitHub") | ||
| 28 … | +[index.js:133-142](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L133-L142 "Source code on GitHub") | ||
| 29 | 29 … | ||
| 30 | 30 … | gets a value given a key. The promise resolves with an object containing | |
| 31 | 31 … | `node` the node in the merkle tree and `value` the value of the that the | |
| 32 | 32 … | node contains | |
| @@ -39,9 +39,9 @@ | |||
| 39 | 39 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 40 | 40 … | ||
| 41 | 41 … | ## set | |
| 42 | 42 … | ||
| 43 | -[index.js:129-167](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L129-L167 "Source code on GitHub") | ||
| 43 … | +[index.js:149-151](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L149-L151 "Source code on GitHub") | ||
| 44 | 44 … | ||
| 45 | 45 … | stores a value at a given key | |
| 46 | 46 … | ||
| 47 | 47 … | **Parameters** | |
| @@ -52,9 +52,9 @@ | |||
| 52 | 52 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 53 | 53 … | ||
| 54 | 54 … | ## delete | |
| 55 | 55 … | ||
| 56 | -[index.js:174-226](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L174-L226 "Source code on GitHub") | ||
| 56 … | +[index.js:198-200](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L198-L200 "Source code on GitHub") | ||
| 57 | 57 … | ||
| 58 | 58 … | deletes a value at a given key | |
| 59 | 59 … | ||
| 60 | 60 … | **Parameters** | |
| @@ -64,31 +64,31 @@ | |||
| 64 | 64 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 65 | 65 … | ||
| 66 | 66 … | ## flush | |
| 67 | 67 … | ||
| 68 | -[index.js:232-234](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L232-L234 "Source code on GitHub") | ||
| 68 … | +[index.js:260-263](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L260-L263 "Source code on GitHub") | ||
| 69 | 69 … | ||
| 70 | 70 … | creates a merkle root for the current tree and stores the data perstantly | |
| 71 | 71 … | ||
| 72 | 72 … | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** | |
| 73 | 73 … | ||
| 74 | 74 … | ## emptyTreeState | |
| 75 | 75 … | ||
| 76 | -[index.js:30-32](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L30-L32 "Source code on GitHub") | ||
| 76 … | +[index.js:49-51](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L49-L51 "Source code on GitHub") | ||
| 77 | 77 … | ||
| 78 | 78 … | returns the state of an empty tree | |
| 79 | 79 … | ||
| 80 | 80 … | ## ArrayConstructor | |
| 81 | 81 … | ||
| 82 | -[index.js:38-40](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L38-L40 "Source code on GitHub") | ||
| 82 … | +[index.js:57-59](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L57-L59 "Source code on GitHub") | ||
| 83 | 83 … | ||
| 84 | 84 … | returns an Uint1Array constructir which is used to repersent keys | |
| 85 | 85 … | ||
| 86 | 86 … | Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
| 87 | 87 … | ||
| 88 | 88 … | ## getMerkleLink | |
| 89 | 89 … | ||
| 90 | -[index.js:47-49](https://github.com/dfinity/js-dfinity-radix-tree/blob/fda15f34eac1f4b4ff2d0ef6a7a5fad66936f6ad/index.js#L47-L49 "Source code on GitHub") | ||
| 90 … | +[index.js:66-68](https://github.com/dfinity/js-dfinity-radix-tree/blob/ca8952130fa954fc6fad3847bdd48dd40fc3228f/index.js#L66-L68 "Source code on GitHub") | ||
| 91 | 91 … | ||
| 92 | 92 … | returns a merkle link for some given data | |
| 93 | 93 … | ||
| 94 | 94 … | **Parameters** | |
Built with git-ssb-web