51Degrees Pipeline Node.js  4.1

51Degrees Pipeline for Node.js

DataFile Class Reference

Detailed Description

A datafile used by a FlowElement / Engine to get calculate properties values.

Parameters
{object} - options
{FlowElement} - options.flowElement The FlowElement using the datafile
{string} - options.identifier Name of the datafile
{object} - options.updateURLParams Parameters used to construct the datafile update url if autoupdate is set to true
{string} - options.tempDataDirectory temporary file location (defaults to the operating system defualt)
{boolean} - options.createTempDataCopy whether to copy datafile to temporary location when updating
{mixed} - options.data data, if the file is stored in memory
{string} - options.path path to the datafile
{boolean} - options.autoUpdate whether to automatically update the datafile when required
{boolean} - options.fileSystemWatcher whether to check the datafile's path for changes and update the connected FlowElement's data automatically when the file is changed in the operating system
{number} - options.pollingInterval How often to poll for updates to the datafile (minutes)
{number} - options.updateTimeMaximumRandomisation Maximum randomisation offset in seconds to polling time interval
{boolean} - options.verifyMD5 whether to check a 'content-md5' header in the data file update service against the datafile to verify its contents
{boolean} - options.decompress is the datafile gziped when returning from the update service?
{boolean} - options.download should the datafile be downloaded or stored in memory
{Function} - options.getDatePublished function for getting the published date of the datafile
{Function} - options.getNextUpdate function for getting the next available update from the datafile
{boolean} - options.verifyIfModifiedSince whether to check an "If-Modified-Since" header on the update service against the last datafile update date
{boolean} - options.updateOnStart whether to update the datafile as soon as it is initialised
{boolean} - options.isRegistered whether the datafile has already been registered with a datafile update service (defaults to false)
{Function} - options.refresh callback to call when datafile has been updated. Defaults to a refresh method on the attached FlowElement

Public Member Functions

 constructor ({ flowElement, identifier, updateURLParams, tempDataDirectory=os.tmpdir(), createTempDataCopy=true, data, path, autoUpdate=true, fileSystemWatcher=true, pollingInterval=30, updateTimeMaximumRandomisation=10, verifyMD5=true, decompress=true, download=true, getDatePublished, getNextUpdate, verifyIfModifiedSince=true, updateOnStart=false, isRegistered=false, refresh })
 refresh (identifier)
Function called when datafile has been updated. More...
get  updateUrl ()
Getter for the update url for the datafile update service to use. More...
 urlFormatter ()
Function that constructs the url for the datafile update service to use. More...

Member Function Documentation

◆ refresh()

DataFile::refresh (   identifier )
inline

Function called when datafile has been updated.

Defaults to a refresh method on the attached FlowElement Can also be overriden by a refresh paramater in the options of the constructor

Parameters
{string} - identifier the identifier of the datafile

◆ updateUrl()

get DataFile::updateUrl ( )
inline

Getter for the update url for the datafile update service to use.

Returns
{string} url

◆ urlFormatter()

DataFile::urlFormatter ( )
inline

Function that constructs the url for the datafile update service to use.

Returns
{string} url