Module @libp2p/record

This is an implementation of the routing record format used by libp2p to store data in the datastore passed to the libp2p constructor.

Example: Deserialization

import { Libp2pRecord } from '@libp2p/record'

const buf = Uint8Array.from([0, 1, 2, 3])
const record = Libp2pRecord.deserialize(buf)

Example: Serialization

import { Libp2pRecord } from '@libp2p/record'

const key = Uint8Array.from([0, 1, 2, 3])
const value = Uint8Array.from([0, 1, 2, 3])
const timeReceived = new Date()

const record = new Libp2pRecord(key, value, timeReceived)
const buf = record.serialize()

@libp2p/record

libp2p record implementation

About

This is an implementation of the routing record format used by libp2p to store data in the datastore passed to the libp2p constructor.

Example - Deserialization

import { Libp2pRecord } from '@libp2p/record'

const buf = Uint8Array.from([0, 1, 2, 3])
const record = Libp2pRecord.deserialize(buf)

Example - Serialization

import { Libp2pRecord } from '@libp2p/record'

const key = Uint8Array.from([0, 1, 2, 3])
const value = Uint8Array.from([0, 1, 2, 3])
const timeReceived = new Date()

const record = new Libp2pRecord(key, value, timeReceived)
const buf = record.serialize()

Install

$ npm i @libp2p/record

Browser `<script>` tag

Loading this module through a script tag will make its exports available as Libp2pRecord in the global namespace.

<script src="https://unpkg.com/@libp2p/record/dist/index.min.js"></script>

API Docs

https://libp2p.github.io/js-libp2p/modules/_libp2p_record.html

License

Licensed under either of

Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Index

Classes

Libp2pRecord