fluencelabs/js-peer-id
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-peer-id synced 2025-05-15 08:11:20 +00:00
Code Issues Projects Releases Wiki Activity

cleanup comments

Browse Source
This commit is contained in:
Friedel Ziegelmayer 2016-12-05 20:37:38 +01:00
parent 0d3d9f835b
commit 1be7d888d6
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/index.js
View File

@ -146,6 +146,7 @@ class PeerId {
* @param {Object=} opts - Configuration object. * @param {Object=} opts - Configuration object.
* @param {number} [opts.bits=2048] - How many bits to use for the RSA key generation. * @param {number} [opts.bits=2048] - How many bits to use for the RSA key generation.
* @param {function(Error, PeerId)} callback - Node.js style callback. * @param {function(Error, PeerId)} callback - Node.js style callback.
* @returns {undefined}
* *
* @example * @example
* const PeerId = require('peer-id') * const PeerId = require('peer-id')
@ -216,6 +217,7 @@ PeerId.createFromB58String = function (str) {
* *
* @param {string|Buffer} key * @param {string|Buffer} key
* @param {function(Error, PeerId)} callback * @param {function(Error, PeerId)} callback
* @returns {undefined}
*/ */
PeerId.createFromPubKey = function (key, callback) { PeerId.createFromPubKey = function (key, callback) {
let buf = key let buf = key
@ -243,6 +245,7 @@ PeerId.createFromPubKey = function (key, callback) {
* @param {string|Buffer} key - The private key, if passed as * @param {string|Buffer} key - The private key, if passed as
* string `base64` encoding is assumed. * string `base64` encoding is assumed.
* @param {function(Error, PeerId)} callback * @param {function(Error, PeerId)} callback
* @returns {undefined}
*/ */
PeerId.createFromPrivKey = function (key, callback) { PeerId.createFromPrivKey = function (key, callback) {
let buf = key let buf = key
@ -273,6 +276,7 @@ PeerId.createFromPrivKey = function (key, callback) {
* *
* @param {PeerIdJson} obj * @param {PeerIdJson} obj
* @param {function(Error, PeerId)} callback * @param {function(Error, PeerId)} callback
* @returns {undefined}
*/ */
PeerId.createFromJSON = function (obj, callback) { PeerId.createFromJSON = function (obj, callback) {
if (typeof callback !== 'function') { if (typeof callback !== 'function') {