1. Inicio
  2. Classes
  3. documents/model

new documents/model()

Descripción

A model is the first level if usable data-bearing entity in the system. It does NOT include any verbs for saving or anything like
that, it is a pure, in memory data container

Detalles

documents/model.js, line 34

Miembros

<private> _idField :string

Descripción

The name of the field that uniquely identifies a record. When provided, some operations will take advantage of it

Detalles
string

documents/model.js, line 40

<private> _pkey :*

Descripción

The value of the primary key if documents/model#_idField is filled in. It will be null if none found

Detalles
*

documents/model.js, line 60

isNew :boolean

Descripción

If documents/model#_idField is filled in and it's value is empty this will be true.

Detalles
boolean

documents/model.js, line 86

isEmpty :boolean

Descripción

Returns true if this instance is empty

Detalles
boolean

documents/model.js, line 101

Métodos

<static> get( path, record ) → {*}

Descripción

Reaches into an object and allows you to get at a value deeply nested in an object. This is not a query, but a
straight reach in, useful for event bindings

Parámetros
Nombre Tipo Descripción
path array

The split path of the element to work with
record object

The record to reach into
Returns

Whatever was found in the record

Detalles

documents/probe.js, line 930

<static> set( path, record, setter, newValue )

Descripción

This will write the value into a record at the path, creating intervening objects if they don't exist. This does not work as filtered
update and is meant to be used on a single record. It is a nice way of setting a property at an arbitrary depth at will.

Parámetros
Nombre Tipo Descripción
path array

The split path of the element to work with
record object

The record to reach into
setter string

The set operation. See module:documents/probe.updateOperators for the operators you can use.
newValue object

The value to write to the, or if the operator is $pull, the query of items to look for
Detalles

documents/probe.js, line 918

<static> any( obj, qu ) → {boolean}

Descripción

Returns true if any of the items match the query

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute. See module:documents/probe.queryOperators for the operators you can use.
Returns
Detalles

documents/probe.js, line 882

<static> all( obj, qu ) → {boolean}

Descripción

Returns true if all items match the query

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute. See module:documents/probe.queryOperators for the operators you can use.
Returns
Detalles

documents/probe.js, line 871

<static> remove( obj, qu ) → {object|array}

Descripción

Remove all items in the object/array that match the query

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute. See module:documents/probe.queryOperators for the operators you can use.
Returns

The array or object as appropriate without the records.

Detalles

documents/probe.js, line 838

<static> findOne( obj, qu ) → {object}

Descripción

Returns the first record that matches the query. Aliased as seek.

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute. See module:documents/probe.queryOperators for the operators you can use.
Returns
Detalles

documents/probe.js, line 788

<static> findOneKey( obj, qu ) → {object}

Descripción

Returns the first record that matches the query and returns its key or index depending on whether obj is an object or array respectively.
Aliased as seekKey.

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute. See module:documents/probe.queryOperators for the operators you can use.
Returns
Detalles

documents/probe.js, line 813

<static> findKeys( obj, qu ) → {array}

Descripción

Find all records that match a query and returns the keys for those items. This is similar to module:documents/probe.find but instead of returning
records, returns the keys. If obj is an object it will return the hash key. If 'obj' is an array, it will return the index

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute. See module:documents/probe.queryOperators for the operators you can use.
Returns
Detalles

documents/probe.js, line 769

<static> find( obj, qu ) → {array}

Descripción

Find all records that match a query

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute. See module:documents/probe.queryOperators for the operators you can use.
Returns

The results

Detalles

documents/probe.js, line 750

<static> update( obj, qu, setDocument )

Descripción

Updates all records in obj that match the query. See module:documents/probe.updateOperators for the operators that are supported.

Parámetros
Nombre Tipo Descripción
obj object | array

The object to update
qu object

The query which will be used to identify the records to updated
setDocument object

The update operator. See module:documents/probe.updateOperators
Detalles

documents/probe.js, line 734

<static> some( obj, qu ) → {boolean}

Descripción

Returns true if any of the items match the query. Aliases as any

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute
Returns
Detalles

documents/probe.js, line 941

<static> every( obj, qu ) → {boolean}

Descripción

Returns true if all items match the query. Aliases as all

Parámetros
Nombre Tipo Descripción
obj array | object

The object to query
qu object

The query to execute
Returns
Detalles

documents/probe.js, line 950