@ui5/fs/AbstractReader

@ui5/fs/AbstractReader

Abstract resource locator implementing the general API for reading resources

Constructor

(abstract) new @ui5/fs/AbstractReader(name)

Description: The constructor.

Source: fs/lib/AbstractReader.js, line 12

Parameters:

Name	Type	Description
name	string	Name of the reader. Typically used for tracing purposes

Methods

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

Description: Locates resources by matching glob patterns.

byGlob("**‏/*.{html,htm}");
byGlob("**‏/.library");
byGlob("/pony/*");

Source: fs/lib/AbstractReader.js, line 51

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: fs/lib/AbstractReader.js, line 78

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>