Skip to main content
Version: 0.5.x

Module: client

High-level ComposeDB client, based on the ComposeDB runtime.

Installation

npm install @composedb/client

Classes

Type Aliases

ComposeClientParams

Ƭ ComposeClientParams: Object

Type declaration

NameTypeDescription
cache?DocumentCacheOptional cache for documents.
ceramicCeramicApi | stringCeramic client instance or HTTP URL.
definitionRuntimeCompositeDefinitionRuntime composite definition, created using the Composite development tools.
remoteExecutor?ExecutorOptional remote query executor.
serverURL?stringOptional query server URL.