Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marxjmoura/inoutjs
I/O JavaScript library
https://github.com/marxjmoura/inoutjs
file inout input-output javascript-library open-source
Last synced: 18 days ago
JSON representation
I/O JavaScript library
- Host: GitHub
- URL: https://github.com/marxjmoura/inoutjs
- Owner: marxjmoura
- License: mit
- Created: 2018-12-08T23:03:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:38:16.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T06:50:43.009Z (about 1 month ago)
- Topics: file, inout, input-output, javascript-library, open-source
- Language: JavaScript
- Size: 846 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# InOut.js - I/O JavaScript library
[](https://circleci.com/gh/marxjmoura/inoutjs)
[](https://codecov.io/gh/marxjmoura/inoutjs)
[](https://npmjs.org/package/inoutjs)
[](https://npmjs.org/package/inoutjs)
[](https://david-dm.org/marxjmoura/inoutjs?type=dev)
[](https://github.com/marxjmoura/inoutjs/blob/master/dist/inout.js)
## Getting started
```
$ npm install inoutjs
```
[or download the latest release](https://github.com/marxjmoura/inoutjs/releases/)
## Usage
Load InOut.js with an ES6 import:
```js
import io from 'inoutjs'
```
InOut.js read and write files by exposing the method `io()`:
```js
document.getElementById('file').onchange = function (e) {
var file = e.target.files[0];
var ioWrapper = io(file); // InOut.js file wrapper
};
```
Creating an empty file:
```js
var ioWrapper = io();
```
Creating from blob:
```js
var ioWrapper = io(blob);
```
### File info
`fullName()` get file name including extension
```js
var fullName = io(file).fullName(); // E.g. foo.txt
```
`name()` get file name without extension
```js
var name = io(file).name(); // E.g. foo
```
`ext()` get file extention
```js
var extension = io(file).ext(); // E.g. txt
```
`type()` get file content type
```js
var type = io(file).type(); // E.g. text/plain
```
`size()` get file size
```js
var size = io(file).size('MB'); // Options: B, KB, MB, GB
```
### Read file
`readChunk()` read chunk
```js
io(file).readChunk(function (chunk, next) {
console.log(chunk === undefined ? 'EOF' : chunk);
next(); // Read next chunk
});
```
`readLine()` read line by line
```js
io(file).readLine(function (line, next) {
console.log(line === undefined ? 'EOF' : line);
next(); // Read next line
});
```
### Write to file
`write()` write content to file
```js
var ioWrapper = io().write('content');
```
`writeLine()` write content to file and break line
```js
var ioWrapper = io()
.writeLine('content')
.writeLine(); // Just break line
```
### Save file
`save()` download the file
```js
io(file).save();
io(file).save('foo.xml'); // Override the file name
io(file).save('foo.xml', 'application/xml'); // Override the file name and type
```
`toFile()` get JavaScript File
```js
var file = io().toFile()
```
### Utility functions
`greaterThan()` file size is greather than option
```js
io(file).greaterThan(100, 'KB'); // Options: B, KB, MB, GB
```
`greaterOrEqual()` file size is greather or equal to option
```js
io(file).greaterOrEqual(100, 'KB'); // Options: B, KB, MB, GB
```
`lowerThan()` file size is lower than option
```js
io(file).lowerThan(100, 'KB'); // Options: B, KB, MB, GB
```
`lowerOrEqual()` file size is lower or equal to option
```js
io(file).lowerOrEqual(100, 'KB'); // Options: B, KB, MB, GB
```
## Bugs and features
Please, fell free to [open a new issue](https://github.com/marxjmoura/inoutjs/issues/new) on GitHub.
## License
[MIT](https://github.com/marxjmoura/inoutjs/blob/master/LICENSE)
Copyright (c) 2018-present, [Marx J. Moura](https://github.com/marxjmoura)