@synor/source-file

Synor Source Engine - File

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@synor/source-file
2150.6.32 years ago3 years agoMinified + gzip package size for @synor/source-file in KB

Readme

Synor Source Version Coverage License
Synor Source File
Synor Source Engine - File

Installation

# using yarn:
yarn add @synor/source-file

# using npm:
npm install --save @synor/source-file

URI

Format: file://[.]/path[?param=value&...]
Params:
| Name | Description | Default Value | | ------------------------- | ------------------------------------------- | ------------- | | ignore_invalid_filename | Flag for ignoring invalid_filename errors | true |
Examples:
  • file:///path/to/directory (Absolute path)
  • file://./path/to/directory (Relative path)
  • file:///path/to/directory?ignore_invalid_filename=false (Throws invalid_filename error)

License

Licensed under the MIT License. Check the LICENSE file for details.