ish.io.fs

Browser-based File System mixin for ish.js

Source:
Author:
  • Nick Campbell
License:
  • MIT

Methods

[mixin] ish.io.fs.load(vFileInput, oOptionsopt)

Source:
Loads the referenced file from the client system.
From Mixin: ish.io.fs.js must be included for ishJS to access this functionality.
Client-Side Only: This functionality is only available under a browser (Firefox, Chrome, etc.).
Parameters:
Name Type Attributes Description
vFileInput variant | string Value representing the file input DOM-based object, as resolvable by ish.type.dom.mk.
oOptions object <optional>
Value representing the desired options:
Properties
Name Type Attributes Default Description
callback function <optional>
Value representing the function to be called on completion; oOptions.callback(eventTargetResult, iIndex, oFile, oOptions).
byteStart integer <optional>
0 Value representing the byte to start reading from the file to upload.
byteEnd string <optional>
0 Value representing the byte to end reading from the file to upload, with 0 representing all of the file.

[mixin] ish.io.fs.save(vData, oOptionsopt)

Source:
Saves the passed value by downloading it onto the client system as a string.
From Mixin: ish.io.fs.js must be included for ishJS to access this functionality.
Client-Side Only: This functionality is only available under a browser (Firefox, Chrome, etc.).
Parameters:
Name Type Attributes Description
vData string | object Value representing the data to download as a string.
oOptions object <optional>
Value representing the desired options:
Properties
Name Type Attributes Default Description
filename string <optional>
'downloaded.txt' Value representing the default filename of the downloaded file.
mimeType string <optional>
'text/plain' Value representing the MIME Type of the downloaded file.
charset string <optional>
'utf-u' Value representing the character set represented within the passed value.
pretty boolean <optional>
false Value representing if JSON-based data is to be saved with inserted whitespace.