@ui5/fs/WriterCollection

@ui5/fs/WriterCollection

Resource Locator WriterCollection

Constructor

new @ui5/fs/WriterCollection(parameters)

Description:
  • The constructor.
Source:
Example
new WriterCollection({
    name: "Writer Collection",
    writerMapping: {
	       "/": writerA,
	       "/my/path/": writerB,
    }
});
Parameters:
Name Type Description
parameters object Parameters
Properties
Name Type Description
name string The collection name
writerMapping object.<string, @ui5/fs/AbstractReaderWriter> Mapping of virtual base paths to writers. Path are matched greedy

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>

write(resource, optionsopt) → {Promise.<undefined>}

Description:
  • Writes the content of a resource to a path.
Source:
Overrides:
Parameters:
Name Type Attributes Description
resource @ui5/fs/Resource Resource to write
options object <optional>
Properties
Name Type Attributes Default Description
readOnly boolean <optional>
 false Whether the resource content shall be written read-only Do not use in conjunction with the drain option. The written file will be used as the new source of this resources content. Therefore the written file should not be altered by any means. Activating this option might improve overall memory consumption.
drain boolean <optional>
 false Whether the resource content shall be emptied during the write process. Do not use in conjunction with the readOnly option. Activating this option might improve overall memory consumption. This should be used in cases where this is the last access to the resource. E.g. the final write of a resource after all processing is finished.
Returns:
Promise resolving once data has been written
Type
Promise.<undefined>