Interface Registry

The protocol registry stores protocol codecs that allow transformation of multiaddr tuples from bytes to string and back again, and also validation of the address values.

interface Registry {
    addProtocol(codec: ProtocolCodec): void;
    getProtocol(key: string | number): ProtocolCodec;
    removeProtocol(code: number): void;
}

Index

Methods

addProtocol getProtocol removeProtocol

Methods

addProtocol

addProtocol(codec: ProtocolCodec): void
Add a new protocol definition
Parameters
- codec: ProtocolCodec
Returns void
- Defined in src/index.ts:173

getProtocol

getProtocol(key: string | number): ProtocolCodec
Retrieve a protocol definition by it's code or name
Parameters
- key: string | number
Returns ProtocolCodec
- Defined in src/index.ts:168

removeProtocol

removeProtocol(code: number): void
Remove a protocol definition by it's code
Parameters
- code: number
Returns void
- Defined in src/index.ts:178