Skip to content

Commit

Permalink
Added some more docu to vfs.js #12
Browse files Browse the repository at this point in the history
  • Loading branch information
andersevenrud committed Jan 9, 2015
1 parent 26c3a65 commit 49140bb
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions src/javascript/vfs.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,24 @@
//
// See 'src/javascript/vfs/' for the specific modules.
//
// You should read the information below!
//
// ---------------------------------------------------------------------------
//
// Functions that take 'metadata' (File Metadata) as an argument (like all of them)
// it expects you to use an instance of OSjs.VFS.File()
//
// VFS::read(new OSjs.VFS.File('/path/to/file', 'text/plain'), callback);
//
// ---------------------------------------------------------------------------
//
// By default all functions that read data will return ArrayBuffer, but you can also return:
// String
// dataSource
// TODO: Blob ?
//
// ---------------------------------------------------------------------------
//
// Functions that take 'data' (File Data) as an argument supports these types:
//
// File Browser internal
Expand All @@ -55,6 +63,16 @@
// OSjs.VFS.FileDataURL Wrapper for dataSource URL strings
// JSON JSON Data defined as: {filename: foo, data: bar}
//
// ---------------------------------------------------------------------------
//
// This a list of modules and their paths
//
// Public / OS.js Public Storage
// User home:/// OS.js User Storage
// OS.js osjs:/// OS.js Dist (Read-only)
// GoogleDrive google-drive:/// Google Drive Storage
// OneDrive onedrive:/// Microsoft OneDrive (SkyDrive)
//

window.OSjs = window.OSjs || {};
OSjs.VFS = OSjs.VFS || {};
Expand Down

0 comments on commit 49140bb

Please sign in to comment.