Skip to main content

Abstract Class: ModelRoute<T>

Defined in: service-core/src/routes/ModelRoute.ts:119

The ModelRoute is an abstract base class that provides a set of built-in route behavior functions for handling requests for a given data model that is managed by a persistent datastore. This class does not provide route handlers for the defined behaviors. This class is intended to serve as a base class for you to extend and hook up your own route handlers that use the included functionality as desired so that you only expose the CRUD endpoints for your model that you desire. If you desire a fully functional set of route handlers that implements all of these behaviors you should extend the CRUDRoute class instead.

Provided behaviors:

  • doCount: Counts the number of objects matching the provided set of criteria in the request's query parameters. Returns the count as the value of the Content-Length header.
  • doCreate: Adds one or more new objects to the datastore.
  • doDelete: Removes an existing object from the datastore.
  • doExists: Checks if the object with the given ID exists in the datastore. Sets Content-Length header to 1 if the object exists, otherwise 0.
  • doFind: Returns all objects matching the provided set of criteria in the request's query parameters.
  • doFindById: Returns a single object with a specified unique identifier.
  • doTruncate: Removes all objects from the datastore.
  • doUpdate: Modifies an existing object in the datastore.
  • doUpdateBulk: Modifies multiple existing objects in the datastore.
  • doUpdateProperty: Modifies an single property of the given name of an existing object in the datastore.

Extended by​

Type Parameters​

T​

T extends BaseEntity | SimpleEntity

Constructors​

Constructor​

new ModelRoute<T>(): ModelRoute<T>

Returns​

ModelRoute<T>

Properties​

aclUtils?​

protected optional aclUtils?: ACLUtils

Defined in: service-core/src/routes/ModelRoute.ts:121

cacheClient?​

protected optional cacheClient?: Redis

Defined in: service-core/src/routes/ModelRoute.ts:125

The redis client that will be used as a 2nd level cache for all cacheable models.

config?​

protected optional config?: any

Defined in: service-core/src/routes/ModelRoute.ts:129

The global application configuration.

defaultACLUid​

protected defaultACLUid: string = ""

Defined in: service-core/src/routes/ModelRoute.ts:132

The unique identifier of the default ACL for the model type.

logger​

protected logger: any

Defined in: service-core/src/routes/ModelRoute.ts:135

notificationUtils?​

protected optional notificationUtils?: NotificationUtils

Defined in: service-core/src/routes/ModelRoute.ts:138

objectFactory?​

protected optional objectFactory?: ObjectFactory

Defined in: service-core/src/routes/ModelRoute.ts:141

repoUtils?​

protected optional repoUtils?: RepoUtils<T>

Defined in: service-core/src/routes/ModelRoute.ts:147

The repository utility class to use for common operations.

repoUtilsClass​

abstract protected readonly repoUtilsClass: any

Defined in: service-core/src/routes/ModelRoute.ts:144

The class of the RepoUtils to use when instantiating the utility.

trackChanges​

protected trackChanges: number = 0

Defined in: service-core/src/routes/ModelRoute.ts:153

The number of previous document versions to store in the database. A negative value indicates storing all versions, a value of 0 stores no versions.

trustedRoles​

protected trustedRoles: string[]

Defined in: service-core/src/routes/ModelRoute.ts:156

Accessors​

modelClass​

Get Signature​

get modelClass(): any

Defined in: service-core/src/routes/ModelRoute.ts:161

The class type of the model this route is associated with.

Returns​

any

Methods​

doBulkCreate()​

protected doBulkCreate(objs, options): Promise<T[]>

Defined in: service-core/src/routes/ModelRoute.ts:259

Attempts to store a collection of objects provided in options.req.body into the datastore. Upon success, sets the newly persisted object(s) to the result property of the options.res argument, otherwise sends a 400 BAD REQUEST response to the client.

Parameters​

objs​

Partial<T>[]

The object(s) to store in the database.

options​

CreateRequestOptions

The options to process the request using.

Returns​

Promise<T[]>

doBulkUpdate()​

protected doBulkUpdate(objs, options): Promise<T[]>

Defined in: service-core/src/routes/ModelRoute.ts:498

Attempts to modify a collection of existing data model objects.

Parameters​

objs​

UpdateObject<T>[]

The object(s) to bulk update in the database.

options​

UpdateRequestOptions<T>

The options to process the request using.

Returns​

Promise<T[]>

doCount()​

protected doCount(options): Promise<HttpResponse>

Defined in: service-core/src/routes/ModelRoute.ts:193

Attempts to retrieve the number of data model objects matching the given set of criteria as specified in the request query. Any results that have been found are set to the content-length header of the res argument.

Parameters​

options​

FindRequestOptions

The options to process the request using.

Returns​

Promise<HttpResponse>

doCreate()​

protected doCreate(obj, options): Promise<T | T[]>

Defined in: service-core/src/routes/ModelRoute.ts:289

Attempts to store one or more objects provided in options.req.body into the datastore. Upon success, sets the newly persisted object(s) to the result property of the options.res argument, otherwise sends a 400 BAD REQUEST response to the client.

Parameters​

obj​

Partial<T> | Partial<T>[]

The object(s) to store in the database.

options​

CreateRequestOptions

The options to process the request using.

Returns​

Promise<T | T[]>

doCreateObject()​

protected doCreateObject(obj, options): Promise<T>

Defined in: service-core/src/routes/ModelRoute.ts:229

Attempts to store an object provided in options.req.body into the datastore. Upon success, sets the newly persisted object(s) to the result property of the options.res argument, otherwise sends a 400 BAD REQUEST response to the client.

Parameters​

obj​

Partial<T>

The object to store in the database.

options​

CreateRequestOptions

The options to process the request using.

Returns​

Promise<T>

doDelete()​

protected doDelete(id, options): Promise<void>

Defined in: service-core/src/routes/ModelRoute.ts:317

Attempts to delete an existing data model object with a given unique identifier encoded by the URI parameter id.

Parameters​

id​

string

The unique identifier of the object to delete.

options​

DeleteRequestOptions

The options to process the request using.

Returns​

Promise<void>

doExists()​

protected doExists(id, options): Promise<any>

Defined in: service-core/src/routes/ModelRoute.ts:363

Attempts to determine if an existing object with the given unique identifier exists.

Parameters​

id​

string

The unique identifier of the object to verify exists.

options​

FindRequestOptions

The options to process the request using.

Returns​

Promise<any>

doFind()​

protected doFind(options): Promise<T[]>

Defined in: service-core/src/routes/ModelRoute.ts:397

Attempts to retrieve all data model objects matching the given set of criteria as specified in the request query. Any results that have been found are set to the result property of the res argument. result is never null.

Parameters​

options​

FindRequestOptions

The options to process the request using.

Returns​

Promise<T[]>

doFindById()​

protected doFindById(id, options): Promise<T | null>

Defined in: service-core/src/routes/ModelRoute.ts:424

Attempts to retrieve a single data model object as identified by the id parameter in the URI.

Parameters​

id​

string

options​

FindRequestOptions

The options to process the request using.

Returns​

Promise<T | null>

doTruncate()​

protected doTruncate(options): Promise<void>

Defined in: service-core/src/routes/ModelRoute.ts:459

Attempts to remove all entries of the data model type from the datastore matching the given parameters and query.

Parameters​

options​

TruncateRequestOptions

The options to process the request using.

Returns​

Promise<void>

doUpdate()​

protected doUpdate(id, obj, options): Promise<T>

Defined in: service-core/src/routes/ModelRoute.ts:526

Attempts to modify an existing data model object as identified by the id parameter in the URI.

Parameters​

id​

string

obj​

UpdateObject<T>

The object to update in the database

options​

UpdateRequestOptions<T>

The options to process the request using.

Returns​

Promise<T>

doUpdateProperty()​

protected doUpdateProperty(id, propertyName, value, options): Promise<T>

Defined in: service-core/src/routes/ModelRoute.ts:577

Attempts to modify a single property of an existing data model object as identified by the id parameter in the URI.

Note that this effectively bypasses optimistic locking and can cause unexpected data overwrites. Use with care.

Parameters​

id​

string

The unique identifier of the object to update.

propertyName​

string

The name of the property to update.

value​

any

The value of the property to set.

options​

UpdateRequestOptions<T>

The options to process the request using.

Returns​

Promise<T>

validate()​

validate(objs, options?): Promise<void>

Defined in: service-core/src/routes/ModelRoute.ts:619

Calls repoUtils.validate() to validate the object(s) provided.

Parameters​

objs​

Partial<T> | Partial<T>[]

options?​

CreateRequestOptions | UpdateRequestOptions<T>

Returns​

Promise<void>