node-shims

node-shims ==========

node-shims

This repository contains a basic set of shims for commonly used node API for use in Chrome Packaged Apps. Most notably net/tls (TCP socket) APIs. Unlike node-browser-builtins, which is used by browserify, we do not require an additional build step, since we use amdefine to build AMD modules that can be used in the browser via requirejs and node environments alike.

In a node enviroment, the native node API is provided. In a Chrome environment, the shims are used. This repo may serve as a drop-in replacement for the builtin node packages in your node module:

var shims = require('node-shims'),
    util = shims.util;

To run the tests in node, do the following:

> npm install
> npm test

To run the tests in Chrome as a Chrome packaged app, do the following:

> npm install
> grunt copy
> node test-server.js

open Chrome
go to chrome://extensions/ 
activate developer mode
load node-shims as unpacked extension
watch the tests pass

Feel free to drop a patch :)

If not stated otherwise, the contents of this library are MIT licensed.

Copyright © 2013 Whiteout Networks GmbH.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
  • node-tls uses crypto primitives from Forge by Digital Bazaar, Inc. which is licensed under BSD and GPL.
  • node-buffer was originally written by Romain Beauxis, see here, licensed under MIT/X11 license.
  • node-crypto uses crypto primitives from Forge by Digital Bazaar, Inc., licensed under BSD and GPL license.
  • node-http was originally written by James Halliday, see here, licensed under MIT/X11 license.
  • node-events, node-stream, node-string-decoder and node-url was originally written by Joyent, Inc. and other Node contributors, see here, licensed under MIT license.