Class: FilterProviderByFile

FilterProviderByFile

new FilterProviderByFile(file, optionsopt)

Provides a filter from a single file Filter will be loaded synchronously as there is no way to determine when a filter is required asynchronously
Parameters:
Name Type Attributes Description
file String The file that represnts an intent
options Object <optional>
 Options
Properties
Name Type Attributes Default Description
preload Boolean <optional>
 false Should the file be preloaded or only loaded when a filter is requested
Implements:
Source:
See:

Methods

getPostFilters() → {Array.Filter}

Returns all the post filters (filters that implement executePost())
Source:
Returns:
Array of all the loaded post filters
Type
Array.Filter

getPreFilters() → {Array.Filter}

Returns all the pre filters (filters that implement executePre())
Source:
Returns:
Array of all the loaded pre filters
Type
Array.Filter

processItem(items, itemId, fileName, options)

Uses node.js require to load the file and register it with the provider system
Parameters:
Name Type Description
items Map Map of the items being processed
itemId String The Id of the item to process
fileName String The name of the file being processed
options Object Any options that are being passed to the ItemProcessor (can be null)
Source:

processItems(items, fileName, options)

Uses node.js require to load the file and register it with the provider system
Parameters:
Name Type Description
items Map Map of the items being processed
fileName String The name of the file being processed
options Object Any options that are being passed to the ItemProcessor (can be null)
Source: