@nhtio/vue-re-active-record

Composables

Function	Description
awaitPluginInit	Waits for the Vue ReActiveRecord plugin to finish initializing the real database in a browser context.
initializeReActiveDatabase	Initializes the Vue ReActiveRecord plugin with the provided configuration and waits for the real database to be ready.
onReActiveDatabaseReady	Registers a callback to be invoked after the Vue ReActiveRecord database is ready in the current Vue component lifecycle.
useReActiveDatabase	Injects and returns the Vue ReActiveRecord database instance from the current Vue application context.
useReActiveModel	Injects and returns a specific model constructor from the Vue ReActiveRecord database.

Constants

Variable	Description
version	The current version of the package.

Core

Variable	Description
default	The singleton instance of the VueReActiveRecordPlugin used as the default export.

Other

Function	Description
isSSRStub	Determines if a given value is an SSR stub implementation.
isWebContext	Determines if the current execution context is a web-like environment.

Types

Name	Description
VueReActiveDatabaseOptions	The configuration options type for the Vue ReActiveRecord database instance.
VueReActivePluginOptions	Options for configuring the Vue ReActiveRecord plugin installation.
VueReactiveQueryCollection	Represents a reactive query collection result for a specific model in Vue ReActiveRecord.
VueReactiveQueryResult	Represents a reactive query result for a single model instance in Vue ReActiveRecord.
VueReActiveRecordInstance	The shape of the Vue ReActiveRecord Database instance. For more information, see the ReactiveDatabase class documentation.
VueReActiveRecordPlugin	Core plugin class that manages the Vue ReActiveRecord integration and database lifecycle.
VueReActiveRecordTypes	An augmentable interface for the Vue ReActiveRecord types.
InferredVueReActiveObjectMap	A utility type that intelligently infers the model object map for your Vue ReActiveRecord application.