Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Expose nodejs modules in the browser.
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
build
example
lib
packages
test
.gitignore
.gitmodules
HELP
Jakefile
LICENSE
README.md
package.json

README.md

Gaseous

Expose nodejs modules in the browser.

Note: This is still a work in progress, use at your own risk, or see alternatives (like nowjs or dnode).

But... If you find this useful or cool, give it a spin or dive into the source.

Install

npm install gaseous

Starting A Server

// bind fs and initiate a server
var gaseous = require('gaseous');
gaseous.map({
    fs: require('fs')
}).listen();

// with the cli
gaseous server -m fs

Using The Client

The client is used to connect and interact with a server instance.

For example: reading the contents of a file.

gaseous.connect(function (modules) {
    // gaseous.modules can now be referenced
    modules.fs.readFile("relative/directory/file", "utf-8", function (err, data) {
        // woot
    });
});

Getting Started

You have to build the browser client file to use it. First, make sure you:

// initialize submodules 
git submodule init
git submodule update

// install some extra npm packages
npm install jake nodeunit sinon catchjs glob argsparser

Build Commands

// build the browser client
jake
jake build

// unit tests
jake test

// code stats
jake stats

Example

// build the gaseous.js browser client and include it in your markup file
jake build

// or use the cli
gaseous build

// run the server example (or use the cli)
node example/server.js

// open example/client.html in a browser
chromium-browser example/client.html

How It Works

The client/server runs on top of socket.io.

There is a caveat in that everything is async, so only certain methods are feasible. When a method call is made, the client will post the method and appropriate paramaters via a stringified data packet to the server. So if you want to use something like fs.readFileSync it will not work as expected.

For example, for fs.readFile the packet would look something like this:

{
    "id": "uuid",
    "method": "fs-readFile",
    "args": [
        "relative/directory/file",
        "utf-8",
        "[Function]"
    ]
}

The server will then process the packet, call the appropriate module method and a message will be sent back to the client with the results of the call.

For example, a successful call (to say fs.readFile) would look something like this:

{
    "id": "uuid",
    "callback": 2 // the index of the callback invoked
    "args": [
        null,
        "file_data"
    ]
}

TODO

  • handle Buffer objects properly (get mangled in stringify)
  • mixin EventEmitter instead of using Observable class
  • handle multiple connections (i.e. listen on multiple ports)
  • pass in an optional server to bind to instead of creating one (i.e. support express, connect etc)
  • support recursive objects (i.e. at the moment, only second level functions are mapped)
  • client uses events and supports connect/disconnect/ready events (and anything else worthy)
  • make client compat lib for older browsers (ex. Object.keys)
  • tweak lib/client to dually work as a commonjs module (in node)
Something went wrong with that request. Please try again.