Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ScarletsFiction/SFFileSystem
Extends functionality of modern browser FileSystem's API (For Chrome & Cordova)
https://github.com/ScarletsFiction/SFFileSystem
cordova file html5 storage website
Last synced: about 1 month ago
JSON representation
Extends functionality of modern browser FileSystem's API (For Chrome & Cordova)
- Host: GitHub
- URL: https://github.com/ScarletsFiction/SFFileSystem
- Owner: ScarletsFiction
- License: mit
- Created: 2018-12-17T06:20:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-17T09:00:51.000Z (almost 6 years ago)
- Last Synced: 2024-08-02T20:46:22.756Z (4 months ago)
- Topics: cordova, file, html5, storage, website
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-indo-projects - SFFileSystem - A filesystem library for saving files inside the browser storage. (JavaScript)
- awesome-indonesia-repo - SFFileSystem - A filesystem library for saving files inside the browser storage. (JavaScript)
- awesome-vietnam-repo - SFFileSystem - A filesystem library for saving files inside the browser storage. (JavaScript)
README
[](LICENSE)
[](LICENSE)
[](https://twitter.com/intent/tweet?text=SFFileSystem%20is%20a%20library%20for%20accessing%20local%20file%20system%20for%20the%20current%20website%20on%20the%20browser.&url=https://github.com/ScarletsFiction/SFFileSystem&via=github&hashtags=SFFileSystem,file,html5,storage,cordova)
# SFFileSystem
A library for accessing local file system for the current website on the browser
## How to use
### Initialization
```js
var myFile = new SFFileSystem({ options });
```
### Options
| Property | Details |
| --- | --- |
| home | Set the root folder |
| temporary | Store file to temporary storage that will vanish when the browser was refreshed |
| callback | Callback if the initialization was success |
| initError | Callback if the initialization was failed |
### Available Methods
#### home
This is the current root folder
```js
if(myFile.home.isDirectory === true)
console.log("I'm a folder");
// For other usage please check the 'Directory Entry' and 'Both Entry'
```
#### path
Get directory entry from directory path
```js
myFile.path('/myFolder/subFolder', function(dirEntry){
dirEntry.isDirectory === true
}, console.error);
```
#### exist
Check if file/folder was exist and return the type of the target
```js
myFile.exist('/myFolder/subFolder', function(exist){
if(exist === 'file' || exist === 'folder')
console.log(true);
else
console.log(false);
}, console.error);
```
#### list
Get contents from a path and return an array of string
```js
myFile.list('/myFolder', function(list){
list instanceof Array;
// ['myFile.txt', 'myFolder']
});
```
#### contents
Get contents from a path and return their Entry
```js
myFile.contents('/myFolder', function(list){
list instanceof Array;
// [FileEntry, DirectoryEntry, ...]
});
```
### Directory Entry
#### newFolder
Create new folder and get it's Entry
```js
dirEntry.newFolder('myFolder', function(subFolder){
subFolder.isDirectory === true;
});
```
#### newFile
Create new file and get it's Entry
```js
dirEntry.newFile('myFile', function(fileEntry){
// fileEntry.write('stuff');
});
```
#### getFolder
Go to deeper folder and return the Directory Entry
```js
dirEntry.getFolder('myFolder', function(subFolder){
subFolder.isDirectory === true;
});
```
#### getFile
Get the file entry inside current folder
```js
dirEntry.getFile('myFile', function(fileEntry){
fileEntry.isFile === true;
});
```
#### exist
Check if file/folder was exist and return the type of the target
```js
dirEntry.exist('myFolder', function(list){
if(exist === 'file' || exist === 'folder')
console.log(true);
else
console.log(false);
});
```
#### contents
Get contents from current folder and return their Entry
```js
dirEntry.contents(function(list){
list instanceof Array;
// [FileEntry, DirectoryEntry, ...]
});
```
#### list
Get contents from current folder and return their Entry
```js
dirEntry.list(function(list){
list instanceof Array;
// ['myFile.txt', 'myFolder']
});
```
### File Entry
#### write
Write blob or string to current file
```
fileEntry.write('string' || new Blob(['any'], {type:"text/plain"}));
```
#### append
Append blob or string to current file
```
fileEntry.append('string' || new Blob(['any'], {type:"text/plain"}));
```
#### read
Read current file as a string
```
fileEntry.read(function(value){
console.warn(value);
});
// The alternative method is accessing the file from it's url
var url = fileEntry.toURL();
```
### Both Entry
#### remove
Rename current file/folder
```
anyEntry.remove();
dirEntry.removeRecursively();
```
#### rename
Rename current file/folder
```
anyEntry.rename('targetName');
```
#### copyTo
Copy current file/folder to other directory
```
anyEntry.copyTo('path' || DirectoryEntry);
```
#### moveTo
Move current file/folder to other directory
```
anyEntry.moveTo('path' || DirectoryEntry);
```
#### getParent
Get parent directory for current file/folder
```
anyEntry.getParent(function(dirEntry){
dirEntry.isDirectory == true;
});
```
#### isFile
Return true is current entry is a file
```
if(anyEntry.isFile)
console.log("I'm a file");
```
#### isDirectory
Return true is current entry is a folder
```
if(anyEntry.isDirectory)
console.log("I'm a folder");
```
#### toURL
Return absolute URL of current file/folder
```
var url = anyEntry.toURL();
// url = filesystem:http://localhost/...
```