Skip to content

@nhtio/web-re-active-record/types

Types used by the Reactive Active Record ORM

Enumerations

EnumerationDescription
ReactiveQueryBuilderWhereOperators-
SeveritiesThe numeric values of the log levels, used to calculate if a message should be consumed based on the desired minimum log level.

Classes

ClassDescription
BaseReactiveModelThe abstract base class for all reactive models.
ErrorHandlerA class which allows asyncronously thrown errors to be consumed and handled
LoggerA class which allows log events to be subscribed to.
ReactiveQueryBuilderA fluent query builder for ReactiveModel that provides SQL-like query functionality.
ReactiveQueryCollectionProvides a reactive, observable response for a query that returns a collection of models.
ReactiveQueryResponseProvides a reactive, observable response to a query, automatically re-fetching results when relevant model events occur on the provided UnifiedEventBus.
ReactiveQueryResultProvides a reactive, observable response for a query that returns a single model instance or undefined.
RelationshipBaseThe base class for all relationships

Interfaces

InterfaceDescription
DefaultObjectMapThe shape of the default object map for the ReactiveDatabase.
LogBusEventThe events and the arguments their callbacks receive for the logger.
PendingStateChangeThe shape of the pending state changes for a model.
ReactiveDatabaseInitialLoggerOptionsThe shape of the initial logger options object for the ReactiveDatabase.
ReactiveDatabaseInitialOptionsThe shape of the initial configuration options object for the ReactiveDatabase.
ReactiveDatabaseModelDefinitionThe shape of an object which contains the definition of a model
ReactiveDatabaseOptionsThe shape of the configuration options object for the ReactiveDatabase.
ReactiveModelDescribes the shape of an instance of a ReactiveModel.
ReactiveModelChangeDeltaThe shape of the value of a reactive model change event.
ReactiveModelChangeEmitterEventThe events and the arguments their callbacks receive for the reactive model change emitter.
ReactiveModelChangeEmitterEventMapThe map of events for the reactive model change emitter.
ReactiveModelConstructorDescribes the constructor of a ReactiveModel.
ReactiveQueryBuilderSubQuery-
ReactiveQueryResponseEventMapEvent map for ReactiveQueryResponse events.
ValidationError-
ValidationErrorContext-
ValidationErrorItem-

Type Aliases

Type AliasDescription
DataValuesThe shape of the non-primary key properties for a model.
InferredReactiveModelConstructorUtility type to extract the correct ReactiveModelConstructor for a specified key from ReactiveDatabaseOptions.
LogBusEventMapThe map of events for the logger.
PlainObjectDescribes a non-class, non-null, non-function object which can be used as the properties of a model.
ReactiveRecordWrapperHookGeneric type for wrapper hooks used in ReactiveDatabaseOptions.hooks.
RelatedValueMapMaps all relationships to their value types.
StringKeyOfUtility type to get string keys of an object type.
WrapReactiveModelHookStrongly-typed hook for wrapping ReactiveModel instances.
WrapReactiveQueryCollectionHookStrongly-typed hook for wrapping ReactiveQueryCollection instances.
WrapReactiveQueryResultHookStrongly-typed hook for wrapping ReactiveQueryResult instances.