@nhtio/web-re-active-record/types
Types used by the Reactive Active Record ORM
Enumerations
Enumeration | Description |
---|---|
ReactiveQueryBuilderWhereOperators | - |
Severities | The numeric values of the log levels, used to calculate if a message should be consumed based on the desired minimum log level. |
Classes
Class | Description |
---|---|
BaseReactiveModel | The abstract base class for all reactive models. |
ErrorHandler | A class which allows asyncronously thrown errors to be consumed and handled |
Logger | A class which allows log events to be subscribed to. |
ReactiveQueryBuilder | A fluent query builder for ReactiveModel that provides SQL-like query functionality. |
ReactiveQueryCollection | Provides a reactive, observable response for a query that returns a collection of models. |
ReactiveQueryResponse | Provides a reactive, observable response to a query, automatically re-fetching results when relevant model events occur on the provided UnifiedEventBus. |
ReactiveQueryResult | Provides a reactive, observable response for a query that returns a single model instance or undefined. |
RelationshipBase | The base class for all relationships |
Interfaces
Interface | Description |
---|---|
DefaultObjectMap | The shape of the default object map for the ReactiveDatabase. |
LogBusEvent | The events and the arguments their callbacks receive for the logger. |
PendingStateChange | The shape of the pending state changes for a model. |
ReactiveDatabaseInitialLoggerOptions | The shape of the initial logger options object for the ReactiveDatabase. |
ReactiveDatabaseInitialOptions | The shape of the initial configuration options object for the ReactiveDatabase. |
ReactiveDatabaseModelDefinition | The shape of an object which contains the definition of a model |
ReactiveDatabaseOptions | The shape of the configuration options object for the ReactiveDatabase. |
ReactiveModel | Describes the shape of an instance of a ReactiveModel. |
ReactiveModelChangeDelta | The shape of the value of a reactive model change event. |
ReactiveModelChangeEmitterEvent | The events and the arguments their callbacks receive for the reactive model change emitter. |
ReactiveModelChangeEmitterEventMap | The map of events for the reactive model change emitter. |
ReactiveModelConstructor | Describes the constructor of a ReactiveModel. |
ReactiveQueryBuilderSubQuery | - |
ReactiveQueryResponseEventMap | Event map for ReactiveQueryResponse events. |
ValidationError | - |
ValidationErrorContext | - |
ValidationErrorItem | - |
Type Aliases
Type Alias | Description |
---|---|
DataValues | The shape of the non-primary key properties for a model. |
InferredReactiveModelConstructor | Utility type to extract the correct ReactiveModelConstructor for a specified key from ReactiveDatabaseOptions. |
LogBusEventMap | The map of events for the logger. |
PlainObject | Describes a non-class, non-null, non-function object which can be used as the properties of a model. |
ReactiveRecordWrapperHook | Generic type for wrapper hooks used in ReactiveDatabaseOptions.hooks. |
RelatedValueMap | Maps all relationships to their value types. |
StringKeyOf | Utility type to get string keys of an object type. |
WrapReactiveModelHook | Strongly-typed hook for wrapping ReactiveModel instances. |
WrapReactiveQueryCollectionHook | Strongly-typed hook for wrapping ReactiveQueryCollection instances. |
WrapReactiveQueryResultHook | Strongly-typed hook for wrapping ReactiveQueryResult instances. |