Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Orbit

Orbit DB instance

Hierarchy

  • Orbit

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

identity

identity: Identity

instance

instance: OrbitDB

ipfs

ipfs: IPFS

Methods

generateStoreAddress

  • generateStoreAddress(identity?: null | Identity, name: string, type: DbType): Promise<string>

  • Deterministic store address generation to provide store locations prior to thier creation

    Parameters

    • identity: null | Identity = null
    • name: string
    • type: DbType

    Returns Promise<string>

getDatabase

  • getDatabase<T>(type: DbType, nameOrAddress: string, identity?: Identity): Promise<T>

  • Opens a connection to a store

    Type parameters

    • T

    Parameters

    • type: DbType
    • nameOrAddress: string
    • Optional identity: Identity

    Returns Promise<T>

getOrbitInstance

  • getOrbitInstance(): Promise<OrbitDB>

initialize

  • initialize(): Promise<void>

  • Initialize the OrbitDB instance, this is asynchrounous and therefore requires a way to wait till initilization is complete

    Returns Promise<void>

Static convertDBTypeEnumToType

  • convertDBTypeEnumToType(type: DbType): string

Generated using TypeDoc