mozdev.org

• Tuesday February 9th 2010
• Do you want fries with that project?

Skip to Content

JSLib

Page Updated: December 29, 2005 Latest Version: 0.1.362

	Debug | Install | File I/O | RDF | Network | Sound | Utils | XUL | Zip
	Home | Mailing List | Install | Source Code | Downloads | Bugs | docs | clients

STATUS: Stable

File API

Function List

• Constructor
• File(aPath)
• creates the File object and sets the file path
• Accessors
• initWithPath(aPath);
• Initializes or reinitializes the File object
• open(aMode, aPermissions);
• open a file handle for reading, writing or appending. Permissions are optional. If aMode is omitted, then the file will be opened readonly.
• close();
• closes a file handle
• exists();
• check to see if a file exists
• EOF;
• checks for end of file
• read();
• returns the contents of a file
• readline();
• returns the next line in the file.
• readAllLines();
• returns string array of all lines in file
• write(aContents);
• Writes aContents out to the file.
• File attributes
• permissions;
• returns the files permissions
• dateModified;
• returns the last modified date object
• size;
• returns the file size
• isDir();
• bool returns true if the file is a directory
• isFile();
• bool returns true if the file is a file
• isExec();
• bool returns true if the file is executable
• isSymlink();
• bool returns true if the file is symbolic link
• isHidden();
• bool returns true if the file is hidden
• isSpecial();
• bool returns true if the file is special
• isWritable();
• bool returns true if the file is writable
• isReadable();
• bool returns true if the file is readable
  
• File string manipulation
• path;
• returns the path
• leaf;
• leaf is the endmost file string ex: foo.html in /myDir/foo.html
• ext;
• returns a file extension if there is one
• parent
• returns the a new File object of the files parent
• Direct manipulation
• nsIFIle;
• returns an nsIFile obj
• File utilities
• copy(aDest);
• copies current file to a destination
• clone();
• returns a clone of the jsLib File object
• append(aLeaf);
• appends a leaf on the the curent file object
• appendRelativePath(aRelPath);
• appends a relative path the the current file instance
• create();
• creates a new file
• move(aDest);
• moves a file to a new destination and file object is reinitialized to reflect this move
• remove();
• removes a file, the instance remains unchanged
• equals(aFileObj);
• bool to test if file objects are equal
• URL;
• read only getter that returns the local URL path eg: file:///foo/bar.dat
• Help!
• help;
• currently dumps a list of available functions

Example: js> load('chrome/jslib/jslib.js'); ********************* JS_LIB DEBUG IS ON ********************* js> include('chrome://jslib/content/io/file.js'); *** load: filesystem.js OK *** load: file.js OK true js> var f = new File('/tmp/foo.dat'); js> f.help; Function and Attribute List: initPath(aPath); path; exists(); leaf; parent; permissions; dateModified; nsIFile; move(aDest); append(aLeaf); appendRelativePath(aRelPath); URL; isDir(); isWritable(); isReadable(); isHidden(); isSpecial(); isFile(); isExec(); isSymlink(); open(aMode); read(); readline(); EOF; write(aContents, aPermissions); copy(aDest); close(); create(); remove(); size; ext; help; js> f.remove(); js> f = new File('/tmp/foo.dat'); [object Object] js> f.exists(); false js> f.create(); js> f.open('w'); true js> f.write('This is a new line #1\n'); true js> f.close(); js> f.open(); true js> f.read(); This is a new line #1 js> f.open('a'); true js> f.write('this is a new line #2\n'); true js> f.close(); js> f.open(); true js> f.read(); This is a new line #1 this is a new line #2 js> f.close(); js> f.permissions; 644 js> f.size; 44 js> f.path; /tmp/foo.dat js> f.ext; dat js> f.move('/tmp/foo.baz.bar'); foo.baz.bar filesystem.js:move successful! true js> f.path; /tmp/foo.baz.bar js> f.parent.path; /tmp js> f.parent.isDir(); true js> f.remove(); js> f.path; /tmp/foo.baz.bar js> f.exists(); false js> f.create(); js> f.copy('/tmp/someNewFile.dat'); file.js:copy successful! true js> f.initPath('/tmp'); /tmp js> f.path; js> f.append('someNewFile.dat'); /tmp/someNewFile.dat js> f.exists(); true js> f.dateModified; Fri Jun 15 15:10:01 GMT-0400 (EDT) 2001 js> f.dateModified.getYear(); 101 js> f.dateModified.toLocaleString(); Fri Jun 15 15:10:01 2001 js> f.dateModified.getMonth(); 5 js> f.leaf; someNewFile.dat js> f.nsIFile.path; /tmp/someNewFile.dat js> quit();