Setting

libflitter/database/model/Setting~ Setting

A model for tracking one-off settings.

Constructor

new Setting()

Source:

Extends

Members

(static) schema

Get the schema for this model.

Source:

(private) __embedded :boolean

True if the model is embedded within a parent.

Type:
  • boolean
Inherited From:
Source:

(private) __embedded_parent :module:flitter-orm/src/model/Model~Model|boolean

If the model is embedded within a parent, this is the reference to that parent. Otherwise, false.

Type:
Inherited From:
Source:

(private) __relation_cache :module:flitter-orm/src/model/ResultCache~ResultCache

Cache for results of relationship lookups for the instance.

Type:
Inherited From:
Source:

(private) __schema_instance :module:flitter-orm/src/schema/Schema~Schema|boolean

The holding variable for the instantiated schema.

Type:
Inherited From:
Source:

(private) _di_allow_defer :boolean

If true, the injector will defer the class if the class requests any services that the container is missing. These services are filled in later and added to the prototype and any instances. True by default.

Type:
  • boolean
Inherited From:
Source:

(private) _di_deferred_instances :Array.<module:flitter-di/src/Injectable~Injectable>

Collection of instances of this class that need to have the deferred service instances injected into them when the deferred services are finally provided.

Type:
Inherited From:
Source:

(private) _di_deferred_services :Array.<string>

List of services that were deferred and not provided at the time of injection.

Type:
  • Array.<string>
Inherited From:
Source:

collection :string|boolean

Optionally, the name of the collection where this model should have its records stored. If none is provided, the collection will be the name of the class.

Type:
  • string | boolean
Inherited From:
Source:

id

If defined, will return the string-form ID of this model.

Inherited From:
Source:

scopes :Array.<module:flitter-orm/src/model/Scope~Scope>

Array of instantiated references to Scopes that should be applied to this model.

Type:
Inherited From:
Source:

Methods

(async, static) get(key) → {Promise.<*>}

Get the value of the setting with the specified key.

Parameters:
Name Type Description
key string
Source:
Returns:
Type
Promise.<*>

(async, static) guarantee(key, value) → {Promise.<*>}

Guarantee that a setting record exists. If it does, fetch its value. Otherwise, set the default value. Return the value that is set for the key.

Parameters:
Name Type Description
key string
value string

default fallback value
Source:
Returns:
  • resolves to the value of the setting (either the default, or the set value)
Type
Promise.<*>

(async, static) set(key, value) → {Promise.<void>}

Set the value of the setting with the specified key. If a setting with the key exists, its value will be updated. Otherwise, a new record will be created.

Parameters:
Name Type Description
key string
value string
Source:
Returns:
Type
Promise.<void>

(private) __collection() → {Collection}

Get the MongoDB collection instance for this model.

Inherited From:
Source:
Returns:
Type
Collection

(async, private) __scope_limit_save(db_object) → {Promise.<object>}

Allow all of the model's registerd scopes to modify the schema-cast database object before it is persisted.

Parameters:
Name Type Description
db_object object
Inherited From:
Source:
Returns:
  • modified db_object
Type
Promise.<object>

(private) __set_values(data, current_objectopt, current_schemaopt)

Shallow copy the values from the specified object to this model.

Parameters:
Name Type Attributes Default Description
data object
current_object object <optional>
 false

for recursion. The current object scope.
current_schema object <optional>
 false

for recursion. The current schema level.
Inherited From:
Source:

belongs_to_many(OtherModel, local_key, foreign_keyopt) → {Promise.<Array.<module:flitter-orm/src/model/Model~Model>>|Array.<module:flitter-orm/src/model/Model~Model>}

Associates many records of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model
local_key string

local key of the field to match
foreign_key string <optional>
 ''

foreign key of the field to match (if none provided, assume the same as local_key)
Inherited From:
Source:
Returns:
  • the matching model instances
Type
Promise.<Array.<module:flitter-orm/src/model/Model~Model>> | Array.<module:flitter-orm/src/model/Model~Model>

belongs_to_one(OtherModel, local_key, foreign_keyopt) → {Promise.<(module:flitter-orm/src/model/Model~Model|undefined)>|module:flitter-orm/src/model/Model~Model}

Associates a single record of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model
local_key string

local key of the field to match
foreign_key string <optional>
 ''

foreign key of the field to match (if none provided, assume the same as local_key)
Inherited From:
Source:
Returns:
  • the matching model instance
Type
Promise.<(module:flitter-orm/src/model/Model~Model|undefined)> | module:flitter-orm/src/model/Model~Model

(async) change(value) → {Promise.<*>}

Change the value of this setting, storing the old value in history.

Parameters:
Name Type Description
value
Source:
Returns:
  • returns this for chaining
Type
Promise.<*>

(async) delete() → {Promise.<module:flitter-orm/src/model/Model~Model>}

Delete the current instance of this model from the database. This will remove the model's ID from this instance. Other properties will remain unchanged.

Inherited From:
Source:
Returns:
Type
Promise.<module:flitter-orm/src/model/Model~Model>

has_many(OtherModel, local_key, foreign_keyopt) → {Promise.<Array.<module:flitter-orm/src/model/Model~Model>>|Array.<module:flitter-orm/src/model/Model~Model>}

Associates many records of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model
local_key string

local key of the field to match
foreign_key string <optional>
 ''

foreign key of the field to match (if none provided, assume the same as local_key)
Inherited From:
Source:
Returns:
  • the matching model instances
Type
Promise.<Array.<module:flitter-orm/src/model/Model~Model>> | Array.<module:flitter-orm/src/model/Model~Model>

has_one(OtherModel, local_key, foreign_keyopt) → {Promise.<module:flitter-orm/src/model/Model~Model>|module:flitter-orm/src/model/Model~Model}

Associates a single record of another model with this model based on a local/foreign key relationship.

Normally, this would be automatically returned by a named method on the sub-class that implements the relationship.

This returns a cached result. So, it will only return a promise on the first call. Subsequent calls will return the results from the cache and are, therefore, synchronous.

Parameters:
Name Type Attributes Default Description
OtherModel module:flitter-orm/src/model/Model~Model

static class of the other model
local_key string

local key of the field to match
foreign_key string <optional>
 ''

foreign key of the field to match (if none provided, assume the same as local_key)
Inherited From:
Source:
Returns:
  • the matching model instance
Type
Promise.<module:flitter-orm/src/model/Model~Model> | module:flitter-orm/src/model/Model~Model

(async) save() → {Promise.<module:flitter-orm/src/model/Model~Model>}

Persist this model instance to the database. This will store only values defined in the schema for this model, and, in so doing, will cast those values and fill in the specified defaults. These changes will be added to this instance after the save.

Inherited From:
Source:
Returns:
  • the current instance with updated properties
Type
Promise.<module:flitter-orm/src/model/Model~Model>

(async) set(field, value) → {Promise.<module:flitter-orm/src/model/Model~Model>}

A convenience method. Set the specified field on this model equal to the specified property and immediately save the record.

Parameters:
Name Type Description
field string
value *
Inherited From:
Source:
Returns:
Type
Promise.<module:flitter-orm/src/model/Model~Model>