Class: ActivitiesModel

ActivitiesModel(id, name, description, deleted, updatedBy)

Represents an activity stored in the activities table.

Constructor

new ActivitiesModel(id, name, description, deleted, updatedBy)

Parameters:
Name Type Description
id number | null

Activity identifier.
name string

Activity name.
description string

Activity description.
deleted number

Soft-delete flag.
updatedBy number

ID of the user who last updated the activity.
Source:

Classes

ActivitiesModel

Members

SORTABLE_COLUMNS

Columns that may be used to sort activity listings.

Source:

Methods

(static) create(activity) → {Promise.<OkPacket>}

Create an activity with a generated identifier.

Parameters:
Name Type Description
activity ActivitiesModel

Activity to create.
Source:
Returns:

Database result.

Type
Promise.<OkPacket>

(static) createWithExistingID(activity) → {Promise.<OkPacket>}

Create an activity with a caller-provided identifier.

Parameters:
Name Type Description
activity ActivitiesModel

Activity to create.
Source:
Returns:

Database result.

Type
Promise.<OkPacket>

(static) delete(id) → {Promise.<OkPacket>}

Delete an activity by its identifier.

Parameters:
Name Type Description
id number

Activity identifier.
Source:
Returns:

Database result.

Type
Promise.<OkPacket>

(async, static) getAll() → {Promise.<Array.<ActivitiesModel>>}

Retrieve all non-deleted activities.

Source:
Returns:

Active activities.

Type
Promise.<Array.<ActivitiesModel>>

(async, static) getById(id) → {Promise.<ActivitiesModel>}

Retrieve an activity by its identifier.

Parameters:
Name Type Description
id number

Activity identifier.
Source:
Throws:

"not found" when no activity matches the identifier.

Type
string
Returns:

Matching activity.

Type
Promise.<ActivitiesModel>

(async, static) getBySearch(term) → {Promise.<Array.<ActivitiesModel>>}

Search non-deleted activities by name or description.

Parameters:
Name Type Description
term string

Search term.
Source:
Returns:

Matching activities.

Type
Promise.<Array.<ActivitiesModel>>

(async, static) list(optionsopt) → {Promise.<{activities: Array.<ActivitiesModel>, total: number}>}

Search and sort non-deleted activities server-side.

Parameters:
Name Type Attributes Description
options Object <optional>

Search and sort options.

Properties
Name Type Attributes Description
searchTerm string <optional>

Optional search term for name/description.
sortBy string <optional>

Column to sort by (name|description).
sortDir string <optional>

Sort direction (asc|desc).
page number <optional>

1-indexed page number for pagination.
pageSize number <optional>

Number of rows per page.
Source:
Returns:

Matching activities and total match count.

Type
Promise.<{activities: Array.<ActivitiesModel>, total: number}>

(static) tableToModel(row) → {ActivitiesModel}

Convert a database row into an ActivitiesModel instance.

Parameters:
Name Type Description
row Object

Database row.
Source:
Returns:

Mapped activity.

Type
ActivitiesModel

(static) update(activity) → {Promise.<OkPacket>}

Update an existing activity.

Parameters:
Name Type Description
activity ActivitiesModel

Activity to update.
Source:
Returns:

Database result.

Type
Promise.<OkPacket>