trifleJS

This is the overall status of the API implementation: 145 components in 184 total (ie 79%)

Feature	Status	Notes
Command Line Options	Partial	7 out of 19 options
Global Methods	Ready	.require() for CommonJS module definition
Object: phantom	Partial	9 out of 11 members
Module: System	Ready	5 out of 5 members
Module: FileSystem	Ready	35 out of 35 members
Module: WebPage	Partial	47 out of 71 members
Module: WebServer	Ready	19 out of 19 members
Module: ChildProcess	Ready	14 out of 14 members
New Features	Partial	8 out of 9 options (IE emulation etc)

Latest Updates

For latest updates from the developer follow @triflejs.

Download Beta

This is still very much work-in-progress. Click here for binaries.

Original PhantomJS API Documentation for this section is in:

https://github.com/ariya/phantomjs/wiki/API-Reference#function-require

Feature	Status	Notes
.require()	Ready	Initialises CommonJS modules

Original PhantomJS API Documentation for this section is in:

https://github.com/ariya/phantomjs/wiki/API-Reference-System

Feature	Status	Notes
Properties
.pid	Ready	Current Process ID for TrifleJS process.
.platform	Ready	Name of platform, always phantomjs.
.os	Ready	Information about the operating system
.env	Ready	Key-value pairs of environment variables
.args	Ready	List of the command-line arguments

Original PhantomJS API Documentation for this section is in:

https://github.com/ariya/phantomjs/wiki/API-Reference-WebPage

Feature	Status	Notes
Properties
.canGoBack	Ready	true if browser can navigate back.
.canGoForward	Ready	true if browser can navigate forward.
.clipRect	To Do	Page area rasterized during .render()
.content	Ready	HTML content of the web page.
.cookies	Partial	Get/set cookies visible in current URL.
.customHeaders	Ready	Additional HTTP headers sent to server.
.event	To Do	Hash object with a list of keyboard events.
.focusedFrameName	Ready	Name of frame IE is currently focused on.
.frameContent	Ready	HTML content of active frame
.frameName	Ready	Name of active window frame
.framePlainText	Ready	Plain Text body in active window frame
.frameTitle	Ready	Title of active window frame
.frameUrl	Ready	Url of active window frame
.framesCount	Ready	Number of frames in browser window
.framesName	Ready	List of names for frames in browser window.
.libraryPath	Ready	Used by .injectJs() to resolve script.
.navigationLocked	To Do	Locks navigation from page (default false)
.offlineStoragePath	Unsupported	Path for cache + cookies. Cannot be changed.
.offlineStorageQuota	Unsupported	Storage for cache + cookies. No quota in IE.
.ownsPages	To Do	true if current page has any child popups.
.pages	To Do	Array of WebPage for child popup pages.
.paperSize	To Do	Size of the page when rendered as PDF.
.plainText	Ready	Content of the web page in plain text.
.scrollPosition	To Do	Scroll position of the web page.
.settings	To Do	Various settings of the web page.
.title	Ready	Title of the page.
.url	Ready	Current URL of the web page.
.viewportSize	Ready	Size of viewport for the layout process.
.windowName	Ready	Name of the main browser window.
.zoomFactor	Ready	Scaling factor for rendering pages.
Methods
.addCookie({cookie})	Partial	Add a (session) cookie to the current page.
.childFramesCount()	Unsupported	Deprecated. Use .framesCount.
.childFramesName()	Unsupported	Deprecated. Use .framesName.
.clearCookies()	Partial	Delete (session) Cookies for current domain.
.close()	Ready	Closes page to release memory.
.currentFrameName()	Unsupported	Deprecated. Use .frameName.
.deleteCookie(name)	Unsupported	Not supported by IE. Use .clearCookies().
.evaluate(function, arg1, arg2,..)	Ready	Evaluates function inside current page.
.evaluateAsync(function, ms, arg1, arg2..)	Ready	Async evaluate() with optional timeout.
.evaluateJavaScript(str)	Ready	Evaluates script in current page.
.getPage(windowName)	To Do	Gets a page inside a window frame.
.goBack()	Ready	Goes back to previous page in history
.goForward()	Ready	Goes forward to next page in history
.go(n)	Ready	Goes back or forwards by n pages in history
.includeJs(url, callback)	Ready	Includes script the specified url
.injectJs(filename)	Ready	Injects script code specified file
.open(url, callback)	Ready	Opens url and loads it to the page.
.open(url, method, callback)	Ready	As above but using a HTTP method.
.open(url, method, data, callback)	Ready	As above, using a HTTP method and data.
.openUrl(url, httpConf, settings)	To Do	Opens url with specific settings.
.release()	Unsupported	Deprecated. Use .close().
.reload()	Ready	Reloads current page.
.render(filename)	Ready	Renders page to specified filename
.renderBase64(format)	Ready	Renders page as Base64-encoded string
.sendEvent(type, [,args..])	To Do	Sends mouse/keyboard event to web page.
.setContent(content, url)	(v1.8)	Sets .content and .url (no http request).
.stop()	Ready	Stops loading the current page.
.switchToFocusedFrame()	Ready	Switches to the frame IE is focused on
.switchToFrame(name)	Ready	Switches current frame by name
.switchToMainFrame()	Ready	Switches current frame to main window
.switchToParentFrame()	Ready	Switches current frame to parent
.uploadFile(selector, path)	To Do	Uploads file in path to a form element
Events
#onAlert	Ready	Fires for alert() calls on page.
#onCallback	Ready	Fires for window.callPhantom calls.
#onClosing	To Do	Fires on window.close()
#onConfirm	Ready	Fires for confirm() calls on page.
#onConsoleMessage	To Do	Fires for console messages on page.
#onError	Ready	Fires when a JavaScript error occurs in the page.
#onFilePicker	To Do	Fires when file added to form input element.
#onInitialized	Ready	Fires after page created and before URL loaded
#onLoadStarted	Ready	Fires when page starts loading.
#onLoadFinished	Ready	Fires when page finishes loading.
#onNavigationRequested	To Do	Fires for all navigations events.
#onPageCreated	To Do	Fires on child page created – ie window.open().
#onPrompt	Ready	Fires when prompt() call made on page.
#onResourceRequested	To Do	Fires for all requests resources (image, css, js etc).
#onResourceReceived	To Do	Fires when resources are received.
#onResourceTimeout	To Do	Fires when resources requested time out.
#onResourceError	(v1.9)	Fires when error occurs loading resource.
#onUrlChanged	To Do	Fires whenever URL changes.

 

PhantomJS API Documentation for this section is in:

http://phantomjs.org/api/child_process/

Note that the original PhantomJS child_process module was left unfinished, there is some additional functionality below that attempts to complete work on the API.

Feature	Status	Notes
Methods
.spawn(path, [args])	Ready	Invoke process and listen on stdout/stderr.
.execFile(path, [args], opts, function)	Ready	Invoke subprocess and execute callback.
.execSync(path, [args], opts)	Ready	Invoke subprocess and waits for exit.
.terminate()	Ready	Terminates all running child processes.

Example

var child_process = require("child_process");
var context = child_process.execFile("dir", ["/a:h","C:\\"], null,
  function (err, stdout, stderr) {
    console.log("execFileSTDOUT:", stdout)
    console.log("execFileSTDERR:", stderr)
    console.log("context.exitCode", context.exitCode);
});

Context Object

This object is returned by child_process methods. It represents the execution context for each child process.

Feature	Status	Notes
Properties
.exited	Ready	true if the process has completed execution
.exitCode	Ready	Usually 0 if successful.
.output	Ready	Console output generated by child process.
.errorOutput	Ready	Error output generated by child process.
.stdout	Ready	Lightweight Stream object for console standard output.
.stderr	Ready	Lightweight Stream object for console standard error.
Methods
.kill()	Ready	Terminates process and disposes of memory allocation.
Events
#onStdOut	Ready	Fires when data is outputted to stdout.
#onStdErr	Ready	Fires when data is outputted to stderr.
#onExit	Ready	Fires when the process terminates.

Note on Event Handling:

The Context object event handlers have been created in a very flexible format, allowing for the variations that appear in the PhantomJS child_process API, a simplification of the same, and the event handling conventions used elsewhere in the PhantomJS project.

As per PhantomJS child_process API definition:

var context = child_process.spawn('triflejs.exe', ['--help']);
context.stdout.on('data', function(data) { console.log(data); });
context.stdout.on('data', function(data) { console.error(data); });
context.on('exit', function(code) { phantom.exit(code); });

Here is the (recommended) simplified version:

var context = child_process.spawn('triflejs.exe', ['--help']);
context.on('stdout', function(data) { console.log(data); });
context.on('stderr', function(data) { console.error(data); });
context.on('exit', function(code) { phantom.exit(code); });

Or alternatively (as used in the Phantom object and WebPage module):

var context = child_process.spawn('triflejs.exe', ['--help']);
context.onStdOut = function(data) { console.log(data); };
context.onStdErr = function(data) { console.error(data); };
context.onExit = function(code) { phantom.exit(code); };

An ECMAv5 javascript setter is used in the last example to avoid overwriting a previously defined event listener/callback. To clear all listeners for a particular event just use context.onExit = null;.

• v0.3 – 56% of PhantomJS API – Release Notes
• v0.4 – 72% of PhantomJS API – Release Notes
• v0.5 – (work in progress…)
• v0.6 – 100% of PhantomJS non-WebPage modules, 80% of WebPage module API
• v0.7 – 100% of PhantomJS Core API (v1.7) + internal unit tests
• v0.8 – CasperJS Support (implement Test suite and fixes)
• v0.9 – Testing and Support for Windows platforms (after XP SP2).
• v1.0 – Only minor Bugfixes left
• v1.1 – Nice to haves (WebDriver, improved IPC, REPL Autocompletion etc)