Source

Source

Abstract class that defines contract for record sources

Constructor

new Source()

Source:

source.js, line 7

Methods

(static) instance() → {Source}

Gets the source singleton

Source:

source.js, line 12

Returns:

Type:: Source

filter(records) → {Array.<Record>}

Filters records based on configuration The filters are set in the config as a key and set of values, such as:

filters: {
  property: ['value1', 'value2'],
}

The property is taken from the meta attribute of the record

Source:

source.js, line 28

Parameters:

Name	Type	Description
`records`	`Array.<Record>`

Returns:

Type:: Array.<Record>

The records after the filter is applied

(async) loadAll() → {Promise.<Array.<Record>>}

Loads all records - this function must be implemented by subclasses

Source:

source.js, line 77

Returns:

Type:: Promise.<Array.<Record>>

The records to be processed

(async) loadRecord(record) → {Promise.<void>}

Called just before the record is processed - for last minute operations

Source:

source.js, line 86

Parameters:

Name	Type	Description
`record`	`Record`

Returns:

Type:: Promise.<void>