JAXDisk

JAXDisk is a IndexDB backed Web file system. It provides async/sync access to the file system. To reduce the complexity of storage DB, root dirs are disk object that has own dedicated IndexDB. Only disk dirs is allowed in root path.

Node.js API

You can use this lib by using node.js fs API by import the file: utils/fs.js
Most async functions are implemented, sync functions will be supported in next update.

JAXDisk API

If you like to directly use JAXDisk API, import the file lib/JAXDisk.js.

New dir

async JAXDisk.newDir(path:string, ?allowDisk:boolean=false, ?recursive:boolean=true ):Promise<boolean>

Description: Asynchronously create a new dir at [path], return a , fulfills true on success.
Arguments:

path: string, the path to make new dir
allowDisk: boolean, when true, new disk will be created if the path is a disk. default: fase.
recursive: recursively create dir if upper dir is not exist.

Delete item

async JAXDisk.del(path:string, ?allowDisk:boolean=false, ?recursive:boolean=true):Promize<boolean>

Description: Asynchronously delete a entry (file or dir) at [path], return a fulfills true on success.
Arguments:

path: string, the path to delete
allowDisk: boolean, when true, disk will be delete if the path is a disk. default: fase.
recursive: recursively delete dir contents if path is a dir.

Read file contents

async JAXDisk.readFile(path:string, ?encode:string):Promise<Uint8Array|string>

Description: Asynchronously read a file's full contents. return a fulfills witch file content on success. Error will be throwed if item at path is not a file.
Arguments:

path: string, file path to read.
encode: string, if been set, fulfill with string content, only "utf8" supported by now.

Write file

async JAXDisk.writeFile(path:string, data:Uint8Array|File|string, ?encode:string):Promise<boolean>

Description: Asynchronously write a file's full contents. return a fulfills witch true on success. Error will be throwed if item at path is not a file.
Arguments:

path: string, file path to write.
data: Uint8Array|File|string, content to write.
encode: string, if been set, convert data to string, only "utf8" supported by now.

Get dir-sub-items' name list:

async JAXDisk.getEntryNames(path:string):Promise<array|null>

Description: Asynchronously get a path's sub entries' name (file or dir). return a fulfills witch Array of string (names) on success, with null if path is not exist.
Arguments:

path: string, file path to get sub items.

Get dir-sub-items' entry list:

async JAXDisk.getEntrys(path:string):Promise<array|null?

Description: Asynchronously get a path's sub entry list (file or dir). return a fulfills witch Array of object on success, with null if path is not exist.
Arguments:

path: string, file path to get sub items.

//dir info:
{
	name:string,//Dir name
	dir:1,//This is a dir
	createTime:number,//Dir create time
}
//file info:
{
	name:string,//File name,
	createTime:number,//File create time,
	modifyTime:number,//Last modify time
	size:integer,//File size
}

Get entry info:

async JAXDisk.getEntry(path:string):Promise<object|null>

Description: Asynchronously get a entry (file or dir)'s infomation. return a fulfills witch info-object on success, with null if path is not exist.
Arguments:

path: string, file path get info.

//dir info:
{
	name:string,//Dir name
	dir:1,//This is a dir
	createTime:number,//Dir create time
}
//file info:
{
	name:string,//File name,
	createTime:number,//File create time,
	modifyTime:number,//Last modify time
	size:integer,//File size
}

Copy file(s):

async JAXDisk.copy(orgPath:string,dstPath:string):Promise<boolean>

Description: Asynchronously copy files to dest path. return a fulfills witch boolean mean success or not.
Arguments:

orgPath: string, source file/dir path to copy.
dstPath: string, target file/dir path to copy.

Avdpro / JAXDisk