documentation 4.0.0-rc.0

documentation

4.0.0-rc.0

Highlighted section
Klass ▸
- Static members
- .isClass
- .isWeird
- .isBuffer
- .isArrayOfBuffers
- .MAGIC_NUMBER
- Instance members
- #getFoo
- #withOptions
- Events
- ⓔ event
CustomError
bar
bar
bar
Foo ▸
- Instance members
- #bar
customStreams ▸
- Static members
- .passthrough

Highlighted section

The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.

var PeerId = require('peer-id')

PeerId.create({ bits: 1024 }, (err, id) => {
  console.log(JSON.stringify(id.toJSON(), null, 2)
})

{
  "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
  "privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
  "pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
}

Klass

Creates a new Klass

new Klass(foo: any)

Extends Stream.Writable

Parameters

foo (any)

Static Members

▸ isClass(other, also)

Decide whether an object is a Klass instance This is a [klasssic]Klass This is a [link to something that does not exist]DoesNot

isClass(other: Object, also: any): boolean

Parameters

other (Object)

also (any)

Returns

boolean: whether the other thing is a Klass

▸ isWeird(other)

A function that triggers the case where the autolinker doesn't find the referenced class type

isWeird(other: Weird): boolean

Parameters

other (Weird)

Returns

boolean: whether the other thing is a Klass

▸ isBuffer(buf, size)

This method takes a Buffer object that will be linked to nodejs.org

isBuffer(buf: (Buffer | string), size: number): boolean

Parameters

buf ((Buffer | string))

size

(number
            = 0)

size

Returns

boolean: whether the other thing is a Klass

▸ isArrayOfBuffers(buffers)

This method takes an array of buffers and counts them

isArrayOfBuffers(buffers: Array<Buffer>): number

Parameters

buffers (Array<Buffer>) some buffers

Returns

number: how many

Example

var k = new Klass();
k.isArrayOfBuffers();

▸ MAGIC_NUMBER

A magic number that identifies this Klass.

MAGIC_NUMBER

Instance Members

▸ getFoo()

Get this Klass's foo

getFoo(): Number

Returns

Number: foo

Example

this shows you how to getFoo

var x = foo.getFoo();

▸ withOptions(options, otherOptions)

A function with an options parameter

withOptions(options: Object, otherOptions: number?)

Parameters

options (Object)

Name	Description
options.foo `string`
options.bar `number`

otherOptions (number?)

Events

▸ event

Klass event

event

CustomError

a typedef with nested properties

CustomError(other: any, also: any)

Parameters

other (any)

also (any)

Properties

error (object) : An error

error.code string
The error's code
error.description string
The error's description

bar

Get an instance of Klass. Will make a klass instance multiword, like a klass

bar(): Klass

Returns

Klass: that class

bar

Rest property function

bar(toys: ...Number): undefined

Parameters

toys (...Number)

Returns

undefined: nothing

bar

Get an instance of Klass. Will make a klass instance multiword, like a klass. This needs a number input.

bar(): undefined

Returns

undefined: nothing

Foo

This is Foo

new Foo()

Instance Members

▸ bar

This is bar

bar

customStreams

I am the container of stream types

customStreams

Static Members

▸ new passthrough()

I am a passthrough stream that belongs to customStreams

new passthrough()