Module: OrbitDB

Provides an interface for users to interact with OrbitDB.

Source:

Namespaces

OrbitDB

Methods

createOrbitDB(params) → {module:OrbitDB~OrbitDB}

Creates an instance of OrbitDB.

Parameters:
Name Type Description
params Object

One or more parameters for configuring OrbitDB.

Properties
Name Type Attributes Description
ipfs IPFS

An IPFS instance.
id string <optional>

The id of the identity to use for this OrbitDB instance.
identity module:Identity | Object <optional>

An identity instance or an object containing an Identity Provider instance and any additional params required to create the identity using the specified provider.

Properties
Name Type Attributes Description
provider function <optional>

An initialized identity provider.
identities module:Identities <optional>

An Identities system instance.
directory string <optional>

A location for storing OrbitDB data.
Source:
Throws:

"IPFS instance is required argument" if no IPFS instance is provided.

Returns:

An instance of OrbitDB.

Type
module:OrbitDB~OrbitDB