Skip to content

@ui5/fs/readers/Proxy ​

@ui5/fs/readers/Proxy ​

Generic proxy adapter. Allowing to serve resources using callback functions. Read only.

Constructor ​

new @ui5/fs/readers/Proxy(parameters) → {@ui5/fs/readers/Proxy}
​

Description: Constructor

Source: fs/lib/readers/Proxy.js, line 29

Parameters: ​
NameTypeDescription
parametersobject
Properties:
NameTypeDescription
nameobjectName of the reader
getResource@ui5/fs/readers/Proxy~getResourceCallback function to retrieve a resource by its virtual path.
listResourcePaths@ui5/fs/readers/Proxy~listResourcePathsCallback function to list all available virtual resource paths.
Returns: ​

Reader instance

Type: @ui5/fs/readers/Proxy

Extends ​

  • @ui5/fs/readers/AbstractReader

Type Definitions ​

getResource(virPath) → {Promise<module:@ui5/fs/Resource>}
​

Description: Callback function to retrieve a resource by its virtual path.

Source: fs/lib/readers/Proxy.js, line 4

Parameters: ​
NameTypeDescription
virPathstringVirtual path
Returns: ​

Promise resolving with a Resource instance

Type: Promise<module:@ui5/fs/Resource>

listResourcePaths() → {Promise<Array<string>>}
​

Description: Callback function to list all available virtual resource paths.

Source: fs/lib/readers/Proxy.js, line 13

Returns: ​

Promise resolving to an array of strings (the virtual resource paths)

Type: Promise<Array<string>>