@ui5/fs/adapters/FileSystem

@ui5/fs/adapters/FileSystem

File system resource adapter

Constructor

new @ui5/fs/adapters/FileSystem(parameters)

Description: The Constructor.

Source: fs/lib/adapters/FileSystem.js, line 24

Parameters:

Name	Type	Description
parameters	object	Parameters Properties: Name Type Attributes Default Description virBasePath string Virtual base path. Must be absolute, POSIX-style, and must end with a slash fsBasePath string File System base path. Must be absolute and must use platform-specific path segment separators excludes Array<string> optional List of glob patterns to exclude useGitignore object optional false Whether to apply any excludes defined in an optional .gitignore in the given fsBasePath directory project @ui5/project/specifications/Project optional Project this adapter belongs to (if any)

Extends

• @ui5/fs/adapters/AbstractAdapter

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

Overrides: @ui5/fs/adapters/AbstractAdapter#byGlob

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

Overrides: @ui5/fs/adapters/AbstractAdapter#byPath

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

Overrides: @ui5/fs/adapters/AbstractAdapter#write

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>