EmbeddedCollection

EmbeddedCollection

An extension of the Collection. Used for the specific task of containing embedded Document instances within a parent Document.

Constructor

new EmbeddedCollection(documentData, sourceArray, documentClass)

Parameters:
Name Type Description
documentData DocumentData

The parent DocumentData instance to which this collection belongs

sourceArray Array.<object>

The source data array for the collection in the parent Document data

documentClass function

The Document class implementation contained by the collection

Methods

delete()

set()

toObject(sourceopt) → {Array.<object>}

Convert the EmbeddedCollection to an array of simple objects.

Parameters:
Name Type Attributes Default Description
source boolean <optional>
true

Draw data for contained Documents from the underlying data source?

Returns:

The extracted array of primitive objects

Type
Array.<object>