Module: runtime

ComposeDB runtime module, converting a runtime composite to an executable GraphQL schema.

Installation

npm install @composedb/runtime

Classes

• ComposeRuntime

Type Aliases

ComposeRuntimeParams

Ƭ ComposeRuntimeParams: GetSchemaParams & { cache?: DocumentCache | boolean ; ceramic: CeramicAPI | string ; context?: Context ; loader?: DocumentLoader }

---

Context

Ƭ Context: Object

Type declaration

Name	Type	Description
ceramic	CeramicAPI	Ceramic client instance used internally.
enableDocIndexing	(id: string, shouldIndex: boolean, opts?: UpdateOpts) => Promise<void>	-
getViewerID	() => string | null	-
isAuthenticated	() => boolean	-
loadDoc	<Content>(id: string | CommitID | StreamID, fresh?: boolean) => Promise<ModelInstanceDocument<Content> | null>	-
loader	DocumentLoader	Document loader instance used internally.
queryCount	(query: BaseQuery) => Promise<number>	-
upsertSet	<Content>(model: string, unique: string[], content: Content, options?: UpsertOptions) => Promise<ModelInstanceDocument<Content> | null>	-
upsertSingle	<Content>(model: string, content: Content, options?: UpsertOptions) => Promise<ModelInstanceDocument<Content> | null>	-

---

ContextParams

Ƭ ContextParams: Object

Type declaration

Name	Type	Description
cache?	DocumentCache | boolean	Optional cache for documents.
ceramic	CeramicAPI	Ceramic client instance.
fallbackViewerID?	string | null	Fallback viewer ID to use when the Ceramic instance is not authenticated.

---

GetSchemaParams

Ƭ GetSchemaParams: Object

Type declaration

Name	Type	Description
definition?	RuntimeCompositeDefinition	Runtime composite definition, created using the Composite development tools.
readonly?	boolean	Set the schema to read-only, disabling mutations support.
schema?	GraphQLSchema	GraphQL Schema to use, ignores the definition and readonly parameters if provided.

Functions

createContext

▸ createContext(params): Context

Parameters

Name	Type
params	ContextParams

Returns

Context

---

createGraphQLSchema

▸ createGraphQLSchema(params): GraphQLSchema

Create a GraphQL schema from a runtime composite definition

Parameters

Name	Type
params	CreateSchemaParams

Returns

GraphQLSchema

---

getSchema

▸ getSchema(params): GraphQLSchema

Use or create a GraphQL schema based on the provided parameters.

Parameters

Name	Type
params	GetSchemaParams

Returns

GraphQLSchema

---

printGraphQLSchema

▸ printGraphQLSchema(definition, readonly?): string

Create a GraphQL schema from a runtime composite definition and return its string representation.

Parameters

Name	Type	Default value
definition	RuntimeCompositeDefinition	undefined
readonly	boolean	false

Returns

string