@ui5/fs/readers/Filter

@ui5/fs/readers/Filter

A reader that allows dynamic filtering of resources passed through it

Constructor

new @ui5/fs/readers/Filter(parameters)

Description:
  • Constructor
Source:
Parameters:
Name Type Description
parameters object Parameters
Properties
Name Type Description
reader @ui5/fs/AbstractReader The resource reader or collection to wrap
callback @ui5/fs/readers/Filter~callback Filter function. Will be called for every resource read through this reader.

Extends

Methods

byGlob(virPattern, optionsopt) → {Promise.<Array.<@ui5/fs/Resource>>}

Description:
  • Locates resources by matching glob patterns.
Source:
Overrides:
Example
byGlob("**‏/*.{html,htm}");
byGlob("**‏/.library");
byGlob("/pony/*");
Parameters:
Name Type Attributes Description
virPattern string | Array.<string> glob pattern as string or array of glob patterns for virtual directory structure
options object <optional>
 glob options
Properties
Name Type Attributes Default Description
nodir boolean <optional>
 true Do not match directories
Returns:
Promise resolving to list of resources
Type
Promise.<Array.<@ui5/fs/Resource>>

byPath(virPath, optionsopt) → {Promise.<@ui5/fs/Resource>}

Description:
  • Locates resources by matching a given path.
Source:
Overrides:
Parameters:
Name Type Attributes Description
virPath string Virtual path
options object <optional>
 Options
Properties
Name Type Attributes Default Description
nodir boolean <optional>
 true Do not match directories
Returns:
Promise resolving to a single resource
Type
Promise.<@ui5/fs/Resource>

Type Definitions

callback(resource) → {boolean}

Description:
  • Filter callback
Source:
Parameters:
Name Type Description
resource @ui5/fs/Resource Resource to test
Returns:
Whether to keep the resource
Type
boolean