Class Welo

constructor

• new Welo(__namedParameters): Welo

• Parameters

  • __namedParameters: Config

  Returns Welo

Readonly events

Readonly identity

Readonly ipfs

Readonly keychain

Readonly opened

determine

• determine(settings, options?): Promise<Manifest>

• Deterministically create a database manifest

  Options are shallow merged with defaultManifest.

  Parameters

  • settings: Determine

    Override defaults used to create the manifest.

  • Optional options: AbortOptions

  Returns Promise<Manifest>

fetch

• fetch(address, options?): Promise<Manifest>

• Fetch a Database Manifest

  Convenience method for using Manifest.fetch.

  Parameters

  • address: Address

    the Address of the Manifest to fetch

  • Optional options: AbortOptions

  Returns Promise<Manifest>

getComponents

• getComponents(manifest): DbComponents

• Parameters

  • manifest: Manifest

  Returns DbComponents

open

• open(manifest, options?): Promise<Database>

• Opens a database for a manifest.

  This method will throw an error if the database is already opened or being opened. Use Welo.opened to get opened databases.

  Parameters

  • manifest: Manifest

    the manifest of the database to open

  • options: OpenOptions = {}

    optional configuration for how to run the database

  Returns Promise<Database>

  the database instance for the given manifest