From 003df64f4655a95b0c2a63d0dc91bcad224a2801 Mon Sep 17 00:00:00 2001 From: Friedel Ziegelmayer Date: Mon, 5 Dec 2016 18:36:10 +0100 Subject: [PATCH] docs: auto build --- index.html | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/index.html b/index.html index c1e4ef3..6a616b2 100644 --- a/index.html +++ b/index.html @@ -61,7 +61,7 @@ font-weight: bold;}.hljs-deletion{background: #fdd;}.hljs-addition{background: # multihash of a public key.

See

static

PeerId.create

create(opts: Object?, callback: function (Error, PeerId))

Create a new PeerId by generating a new public/private keypair.

+

static

PeerId.create

create(opts: Object?, callback: function (Error, PeerId))

Create a new PeerId by generating a new public/private keypair.

Parameters

Name
Description
opts: Object?
Configuration object.
opts.bits: number? (=2048)
How many bits to use for the RSA key generation.
callback: function (Error, PeerId)
Node.js style callback. @@ -72,42 +72,42 @@ PeerId.create((err, idthrow err } console.log('id', JSON.stringify(id)) -})

PeerId.createFromHexString

createFromHexString(str: string): PeerId

Creates a Peer ID from hex string representing the key's multihash.

+})

PeerId.createFromHexString

createFromHexString(str: string): PeerId

Creates a Peer ID from hex string representing the key's multihash.

Parameters

Name
Description
str: string
Hex encoded id

Returns

PeerId.createFromBytes

createFromBytes(buf: Buffer): PeerId

Creates a Peer ID from a buffer representing the key's multihash.

+

PeerId.createFromBytes

createFromBytes(buf: Buffer): PeerId

Creates a Peer ID from a buffer representing the key's multihash.

Parameters

Name
Description
buf: Buffer

Returns

PeerId.createFromB58String

createFromB58String(str: string): PeerId

Creates a Peer ID from a base58 string representing the +

PeerId.createFromB58String

createFromB58String(str: string): PeerId

Creates a Peer ID from a base58 string representing the key's multihash.

Parameters

Name
Description
str: string
base58 encoded id

Returns

PeerId.createFromPubKey

createFromPubKey(key: (string | Buffer), callback: function (Error, PeerId))

Creates a Peer ID from a buffer containing a public key.

-

Parameters

Name
Description
key: (string | Buffer)
callback: function (Error, PeerId)

PeerId.createFromPrivKey

createFromPrivKey(key: (string | Buffer), callback: function (Error, PeerId))

Creates a Peer ID from a buffer containing a private key.

+

PeerId.createFromPubKey

createFromPubKey(key: (string | Buffer), callback: function (Error, PeerId))

Creates a Peer ID from a buffer containing a public key.

+

Parameters

Name
Description
key: (string | Buffer)
callback: function (Error, PeerId)

PeerId.createFromPrivKey

createFromPrivKey(key: (string | Buffer), callback: function (Error, PeerId))

Creates a Peer ID from a buffer containing a private key.

Parameters

Name
Description
key: (string | Buffer)
The private key, if passed as string base64 encoding is assumed. -
callback: function (Error, PeerId)

PeerId.createFromJSON

createFromJSON(obj: PeerIdJson, callback: function (Error, PeerId))

Import a PeerId from a serialized JSON object.

-

Parameters

Name
Description
callback: function (Error, PeerId)

instance

constructor

constructor(id: Buffer, privKey: RSAPrivateKey?, pubKey: RSAPublickKey?)

Parameters

Name
Description
id: Buffer
privKey: RSAPrivateKey?
pubKey: RSAPublickKey?

PeerId.prototype.id

id

PeerId.prototype.privKey

privKey

The private key of this id, if it exists.

-

PeerId.prototype.pubKey

pubKey

The public key of this id, if it exists.

-

PeerId.prototype.marshalPubKey

marshalPubKey(): Buffer

Create the protobuf version of the public key, +

callback: function (Error, PeerId)

PeerId.createFromJSON

createFromJSON(obj: PeerIdJson, callback: function (Error, PeerId))

Import a PeerId from a serialized JSON object.

+

Parameters

Name
Description
callback: function (Error, PeerId)

instance

constructor

constructor(id: Buffer, privKey: RSAPrivateKey?, pubKey: RSAPublickKey?)

Parameters

Name
Description
id: Buffer
privKey: RSAPrivateKey?
pubKey: RSAPublickKey?

PeerId.prototype.id

id

PeerId.prototype.privKey

privKey

The private key of this id, if it exists.

+

PeerId.prototype.pubKey

pubKey

The public key of this id, if it exists.

+

PeerId.prototype.marshalPubKey

marshalPubKey(): Buffer

Create the protobuf version of the public key, matching go-ipfs formatting.

Returns

Buffer The marshalled public key

Throws

Error Failure -

PeerId.prototype.marshalPrivKey

marshalPrivKey(): Buffer

Create the protobuf version of the private key, +

PeerId.prototype.marshalPrivKey

marshalPrivKey(): Buffer

Create the protobuf version of the private key, matching go-ipfs formatting.

Returns

Buffer -

PeerId.prototype.toPrint

toPrint(): PeerIdJson

Alias for toJSON.

+

PeerId.prototype.toPrint

toPrint(): PeerIdJson

Alias for toJSON.

Returns

PeerIdJson -

PeerId.prototype.toJSON

toJSON(): PeerIdJson

Return the jsonified version of the key, matching the formatting +

PeerId.prototype.toJSON

toJSON(): PeerIdJson

Return the jsonified version of the key, matching the formatting of go-ipfs for its config file.

Returns

PeerIdJson -

PeerId.prototype.toHexString

toHexString(): String

Returns the Peer ID's id as a hex string.

+

PeerId.prototype.toHexString

toHexString(): String

Returns the Peer ID's id as a hex string.

Returns

String -

PeerId.prototype.toBytes

toBytes(): Buffer

Returns the Peer ID's id as a buffer.

+

PeerId.prototype.toBytes

toBytes(): Buffer

Returns the Peer ID's id as a buffer.

Returns

Buffer -

PeerId.prototype.toB58String

toB58String(): String

Returns the Peer ID's id as a base58 string.

+

PeerId.prototype.toB58String

toB58String(): String

Returns the Peer ID's id as a base58 string.

Returns

String