require("filestore-disk")(logger, options) → {FileStoreFunctions}
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
logger |
external:base-logger |
<optional> |
Optional logger module that can be injected if required. If logger is not specified, it will default to console. |
options |
module:filestore-disk~Options | the options object for configuring the filestore. |
Returns:
- A map of functions which can be used to access and update the filestore
- Type
- FileStoreFunctions
filestore.disk is a filestore component for zest that manages files on disks drives.
Requires
Type Definitions
-
Config
-
The options object is used to configure the filestore
Type:
- object
- Source:
Properties:
Name Type Description loggerexternal:base-logger | console The logger to be used by this component.
fileEventEventEmitter An event emitter object which is used to emit and listen to file change events.
baseDirstring The absolute path where the files have to be stored.
-
Options
-
The options object is used to configure the filestore
Type:
- object
- Source:
Properties:
Name Type Description baseDirstring The absolute path where the files have to be stored.