docs(api): first pass

Author: dignifiedquire

.gitignore

@@ -31,5 +31,5 @@ build
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
-lib
 dist
+docs

.npmignore

@@ -32,3 +32,4 @@ build
 node_modules
 
 test
+docs

README.md

@@ -34,18 +34,6 @@ const multicodec = require('multicodec')
 
 ### API
 
-#### `multicodec.addPrefix(<multicodecStrOrCode>, <data>)`
-
-> Prefixes a buffer with a multicodec-packed
-
-#### `multicodec.rmPrefix(<prefixedData>)`
-
-> Decapsulate the multicodec-packed prefix from the data
-
-#### `multicodec.getCodec(<prefixedData>)`
-
-> Get the codec of the prefixedData
-
 ## [multicodec default table](https://github.com/multiformats/multicodec/blob/master/multicodec.md)
 
 ## Contribute

example.js

@@ -0,0 +1,8 @@
+'use strict'
+
+const multicodec = require('multicodec')
+
+const prefixedProtobuf = multicodec.addPrefix('protobuf', new Buffer('some protobuf code'))
+
+console.log(prefixedProtobuf)
+// => prefixedProtobuf 0x50...

package.json

@@ -9,9 +9,10 @@
     "test:node": "aegir-test node",
     "test:browser": "aegir-test browser",
     "build": "aegir-build",
-    "release": "aegir-release",
-    "release-minor": "aegir-release --type minor",
-    "release-major": "aegir-release --type major",
+    "docs": "aegir-docs",
+    "release": "aegir-release --docs",
+    "release-minor": "aegir-release --type minor --docs",
+    "release-major": "aegir-release --type major --docs",
     "coverage": "aegir-coverage",
     "coverage-publish": "aegir-coverage publish"
   },
@@ -39,17 +40,17 @@
   },
   "homepage": "https://github.com/multiformats/js-multicodec-packed#readme",
   "dependencies": {
-    "varint": "^4.0.1"
+    "varint": "^5.0.0"
   },
   "devDependencies": {
-    "aegir": "^9.1.2",
+    "aegir": "^9.3.0",
     "chai": "^3.5.0",
-    "pre-commit": "^1.1.3"
+    "pre-commit": "^1.2.2"
   },
   "contributors": [
     "David Dias <[email protected]>",
     "Richard Littauer <[email protected]>",
     "kumavis <[email protected]>",
     "wanderer <[email protected]>"
   ]
-}
+}

src/index.js

@@ -1,11 +1,30 @@
+/**
+ * Implementation of the multicodec specification.
+ *
+ * @module multicodec
+ * @example
+ * const multicodec = require('multicodec')
+ *
+ * const prefixedProtobuf = multicodec.addPrefix('protobuf', protobufBuffer)
+ * // prefixedProtobuf 0x50...
+ *
+ */
 'use strict'
+
 const varint = require('varint')
 const codecNameToCodeVarint = require('./varint-table')
 const codeToCodecName = require('./name-table')
 const util = require('./util')
 
 exports = module.exports
 
+/**
+ * Prefix a buffer with a multicodec-packed.
+ *
+ * @param {string|number} multicodecStrOrCode
+ * @param {Buffer} data
+ * @returns {Buffer}
+ */
 exports.addPrefix = (multicodecStrOrCode, data) => {
   let prefix
 
@@ -21,14 +40,24 @@ exports.addPrefix = (multicodecStrOrCode, data) => {
   return Buffer.concat([prefix, data])
 }
 
+/**
+ * Decapsulate the multicodec-packed prefix from the data.
+ *
+ * @param {Buffer} data
+ * @returns {Buffer}
+ */
 exports.rmPrefix = (data) => {
   varint.decode(data)
   return data.slice(varint.decode.bytes)
 }
 
+/**
+ * Get the codec of the prefixed data.
+ * @param {Buffer} prefixedData
+ * @returns {string}
+ */
 exports.getCodec = (prefixedData) => {
   const code = util.varintBufferDecode(prefixedData)
   const codecName = codeToCodecName[code.toString('hex')]
   return codecName
 }
-