src/index.js

Implementation of the multibase specification.

multibase

src/index.js

multibase(nameOrCode: any, buf: any)

Parameters

nameOrCode (any)

buf (any)

multibase

src/index.js

multibase(nameOrCode: any, buf: any)

Parameters

nameOrCode (any)

buf (any)

multibase

src/index.js

multibase(nameOrCode: any, buf: any)

Parameters

nameOrCode (any)

buf (any)

multibase

src/index.js

multibase(nameOrCode: any, buf: any)

Parameters

nameOrCode (any)

buf (any)

multibase

src/index.js

Create a new Uint8Array with the multibase varint+code.

multibase(nameOrCode: BaseNameOrCode, buf: Uint8Array): Uint8Array

Parameters

nameOrCode (BaseNameOrCode) The multibase name or code number.

buf (Uint8Array) The data to be prefixed with multibase.

Returns

Uint8Array:

Throws

• Error: Will throw if the encoding is not supported

encode

src/index.js

Encode data with the specified base and add the multibase prefix.

encode(nameOrCode: BaseNameOrCode, buf: Uint8Array): Uint8Array

Parameters

nameOrCode (BaseNameOrCode) The multibase name or code number.

buf (Uint8Array) The data to be encoded.

Returns

Uint8Array:

Throws

• Error: Will throw if the encoding is not supported

encode

src/rfc4648.js

encode

Parameters

data (Uint8Array)

alphabet (string)

bitsPerChar (number)

Returns

string:

encode

src/rfc4648.js

encode(input: Uint8Array): string

Parameters

input (Uint8Array)

Returns

string:

decode

src/index.js

Takes a Uint8Array or string encoded with multibase header, decodes it and returns the decoded buffer

decode(data: (Uint8Array | string)): Uint8Array

Parameters

data ((Uint8Array | string))

Returns

Uint8Array:

Throws

• Error: Will throw if the encoding is not supported

decode

src/rfc4648.js

decode

Parameters

string (any)

alphabet (any)

bitsPerChar (any)

decode

src/rfc4648.js

decode

Parameters

string (string)

alphabet (string)

bitsPerChar (number)

Returns

Uint8Array:

decode

src/rfc4648.js

decode(input: string): Uint8Array

Parameters

input (string)

Returns

Uint8Array:

data

src/index.js

data

Type: BaseCode

data

src/index.js

data

Type: BaseCode

data

src/index.js

data

Type: BaseCode

isEncoded

src/index.js

Is the given data multibase encoded?

isEncoded(data: (Uint8Array | string))

Parameters

data ((Uint8Array | string))

validEncode

src/index.js

Validate encoded data

validEncode(name: BaseNameOrCode, buf: Uint8Array): void

Parameters

name (BaseNameOrCode)

buf (Uint8Array)

Returns

void:

Throws

• Error: Will throw if the encoding is not supported

encoding

src/index.js

Get the encoding by name or code

encoding(nameOrCode: BaseNameOrCode): Base

Parameters

nameOrCode (BaseNameOrCode)

Returns

Base:

Throws

• Error: Will throw if the encoding is not supported

src/index.js

Type: BaseName

src/index.js

Type: BaseName

src/index.js

Type: BaseCode

src/index.js

Type: BaseCode

encodingFromData

src/index.js

Get encoding from data

encodingFromData(data: (string | Uint8Array)): Base

Parameters

data ((string | Uint8Array))

Returns

Base:

Throws

• Error: Will throw if the encoding is not supported

identity

src/constants.js

identity

identity

src/constants.js

identity

identity

src/constants.js

identity

identity

src/constants.js

identity

identity

src/constants.js

identity

Type: CodecFactory

constants

src/constants.js

name, code, implementation, alphabet

constants

Type: Array<[BaseName, BaseCode, CodecFactory, string]>

names

src/constants.js

names

Type: Record<BaseName, Base>

src/constants.js

Type: Record<BaseName, Base>

codes

src/constants.js

codes

Type: Record<BaseCode, Base>

codes

src/rfc4648.js

codes

Type: Record<string, number>

src/constants.js

Type: Record<BaseCode, Base>

Base

src/base.js

new Base(name: any, code: any, factory: any, alphabet: any)

Parameters

name (any)

code (any)

factory (any)

alphabet (any)

Instance Members

▸ encode(buf)

src/base.js

encode(buf: Uint8Array): string

Parameters

buf (Uint8Array)

Returns

string:

▸ decode(string)

src/base.js

decode(string: string): Uint8Array

Parameters

string (string)

Returns

Uint8Array:

Base

src/base.js

new Base(name: any, code: any, factory: any, alphabet: any)

Parameters

name (any)

code (any)

factory (any)

alphabet (any)

Instance Members

▸ encode(buf)

src/base.js

encode(buf: Uint8Array): string

Parameters

buf (Uint8Array)

Returns

string:

▸ decode(string)

src/base.js

decode(string: string): Uint8Array

Parameters

string (string)

Returns

Uint8Array:

Base

src/base.js

new Base(name: any, code: any, factory: any, alphabet: any)

Parameters

name (any)

code (any)

factory (any)

alphabet (any)

Instance Members

▸ encode(buf)

src/base.js

encode(buf: Uint8Array): string

Parameters

buf (Uint8Array)

Returns

string:

▸ decode(string)

src/base.js

decode(string: string): Uint8Array

Parameters

string (string)

Returns

Uint8Array:

Base

src/base.js

Class to encode/decode in the supported Bases

new Base(name: BaseName, code: BaseCode, factory: CodecFactory, alphabet: string)

Parameters

name (BaseName)

code (BaseCode)

factory (CodecFactory)

alphabet (string)

Instance Members

▸ encode(buf)

src/base.js

encode(buf: Uint8Array): string

Parameters

buf (Uint8Array)

Returns

string:

▸ decode(string)

src/base.js

decode(string: string): Uint8Array

Parameters

string (string)

Returns

Uint8Array:

rfc4648

src/rfc4648.js

RFC4648 Factory

rfc4648

Parameters

bitsPerChar (number)

Returns

CodecFactory:

decodeText

src/util.js

decodeText

Parameters

bytes ((ArrayBufferView | ArrayBuffer))

Returns

string:

encodeText

src/util.js

encodeText

Parameters

text (string)

Returns

Uint8Array:

concat

src/util.js

Returns a new Uint8Array created by concatenating the passed Arrays

concat(arrs: Array<ArrayLike<number>>, length: number): Uint8Array

Parameters

arrs (Array<ArrayLike<number>>)

length (number)

Returns

Uint8Array: