Commit baff2862fe1006abf980eeb24ba65b81d4f54012
update docs
Signed-off-by: wanderer <mjbecze@gmail.com>wanderer committed on 8/15/2017, 3:37:11 PM
Parent: 31b26dc43440dd6bb683c2f0e63e413890f26274
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -13,15 +13,15 @@ | ||
| 13 | 13 … | # API |
| 14 | 14 … | |
| 15 | 15 … | ## constructor |
| 16 | 16 … | |
| 17 | -[index.js:5-7](https://github.com/wanderer/referanceMap/blob/59a99b6e465120b17057b03bebda1ea33087fb45/index.js#L5-L7 "Source code on GitHub") | |
| 17 … | +[index.js:5-7](https://github.com/wanderer/referanceMap/blob/31b26dc43440dd6bb683c2f0e63e413890f26274/index.js#L5-L7 "Source code on GitHub") | |
| 18 | 18 … | |
| 19 | 19 … | Handle mapping arbitary JS object to ints |
| 20 | 20 … | |
| 21 | 21 … | ## add |
| 22 | 22 … | |
| 23 | -[index.js:15-17](https://github.com/wanderer/referanceMap/blob/59a99b6e465120b17057b03bebda1ea33087fb45/index.js#L15-L17 "Source code on GitHub") | |
| 23 … | +[index.js:15-17](https://github.com/wanderer/referanceMap/blob/31b26dc43440dd6bb683c2f0e63e413890f26274/index.js#L15-L17 "Source code on GitHub") | |
| 24 | 24 … | |
| 25 | 25 … | Adds an object to the referance map returning an int to be used as a |
| 26 | 26 … | referance |
| 27 | 27 … | |
| @@ -32,9 +32,9 @@ | ||
| 32 | 32 … | Returns **integer** |
| 33 | 33 … | |
| 34 | 34 … | ## get |
| 35 | 35 … | |
| 36 | -[index.js:24-30](https://github.com/wanderer/referanceMap/blob/59a99b6e465120b17057b03bebda1ea33087fb45/index.js#L24-L30 "Source code on GitHub") | |
| 36 … | +[index.js:24-30](https://github.com/wanderer/referanceMap/blob/31b26dc43440dd6bb683c2f0e63e413890f26274/index.js#L24-L30 "Source code on GitHub") | |
| 37 | 37 … | |
| 38 | 38 … | gets a POJO given a refernce as an int |
| 39 | 39 … | |
| 40 | 40 … | **Parameters** |
| @@ -44,9 +44,9 @@ | ||
| 44 | 44 … | Returns **any** |
| 45 | 45 … | |
| 46 | 46 … | ## delete |
| 47 | 47 … | |
| 48 | -[index.js:37-39](https://github.com/wanderer/referanceMap/blob/59a99b6e465120b17057b03bebda1ea33087fb45/index.js#L37-L39 "Source code on GitHub") | |
| 48 … | +[index.js:37-39](https://github.com/wanderer/referanceMap/blob/31b26dc43440dd6bb683c2f0e63e413890f26274/index.js#L37-L39 "Source code on GitHub") | |
| 49 | 49 … | |
| 50 | 50 … | deletes an object given a referance as an int |
| 51 | 51 … | |
| 52 | 52 … | **Parameters** |
| @@ -57,10 +57,18 @@ | ||
| 57 | 57 … | Returns **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** whether or not the object was deleted |
| 58 | 58 … | |
| 59 | 59 … | ## clear |
| 60 | 60 … | |
| 61 | -[index.js:44-46](https://github.com/wanderer/referanceMap/blob/59a99b6e465120b17057b03bebda1ea33087fb45/index.js#L44-L46 "Source code on GitHub") | |
| 61 … | +[index.js:44-46](https://github.com/wanderer/referanceMap/blob/31b26dc43440dd6bb683c2f0e63e413890f26274/index.js#L44-L46 "Source code on GitHub") | |
| 62 | 62 … | |
| 63 | 63 … | clears the referance map of a objects |
| 64 | 64 … | |
| 65 … | +## size | |
| 66 … | + | |
| 67 … | +[index.js:52-54](https://github.com/wanderer/referanceMap/blob/31b26dc43440dd6bb683c2f0e63e413890f26274/index.js#L52-L54 "Source code on GitHub") | |
| 68 … | + | |
| 69 … | +returns the number of items in the refernace map | |
| 70 … | + | |
| 71 … | +Returns **integer** | |
| 72 … | + | |
| 65 | 73 … | # LICENSE |
| 66 | 74 … | [MPL-2.0](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)) |
Built with git-ssb-web