An open API service indexing awesome lists of open source software.

https://github.com/loadingio/ldfile


https://github.com/loadingio/ldfile

Last synced: 19 days ago
JSON representation

Awesome Lists containing this project

README

          

# ldfile

file loader helper in vanilla JS.

## Usage

install vis npm:

npm install --save ldfile

include required js file:

then:

var ldf = new ldfile(config);
ldf.on("load", function(ret) {
for(i=0;i. default binary.
* `ldcv`: ldcover for choosing encoding for text type. fallback to browser prompt if omitted.

## API

* `on`: add event listener. Possible events:
- `load`: fired when input value changed, along with a list of objects with following members:
- `file`: the file object provided by browser.
- `result`: file content parsed by ldfile.

## ldfile / Static Methods

* `fromURL(url, type, encoding)` - load file by URL. return promise resolving to {result, file} object.
- params:
- `type`: the same as the type in ldfile object configuration.
- `encoding`: default utf-8 and only applicable when type is text.
- returns a Promise resolving with an object with following fields:
- `result`: parsed content based on given `type`.
- `file`: corresponding file object
- this function can be used to load file from Data URLs.
* `fromFile(file, type, encoding)` - load File object
- same with `fromURL` except that the first param (file) is a File object.
* `download(opt)` - download file based on `opt`, which contains:
- `href`: url for the file to download. either `href` or `blob` should be given.
- `blob`: file to download. ignored if `href` is provided
- `mime`: file format. ( e.g., "application/pdf" )
- `name`: saved filename

## Compatibility

ldfile uses following HTML5 features, which may not be supported by all browsers:

* File Reader ( IE <= 9; read as binary needs polyfill for IE <= 11 )
* Promise ( IE <= 11, some mobile browsers )

Please use Polyfills to support legacy browsers if necessary.

## License

MIT