Naboo's Podracing Misadventure
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    hook.io-webserverpublic

    hook.io-webserver

    a basic hook.io enabled webserver with a socket.io based browser bridge

    Features

    • Provides a cross-browser bridge to hook.io through socket.io
    • Acts as a static file server
    • Built-in Basic Auth options
    • Designed to provide a minimal browser-bridge to hook.io ( no extra cruft )

    Note: For a more full-featured hook.io browser bridge, check out the hook.js project.

    Installation

     npm install hook.io-webserver -g
    

    How does it work?

    hook.io-webserver creates an http server for browsers to connect to. Once connected, these browsers can send and receive messages to the server and each other with websocket support. But...that is boring. Anyone can do that.

     http://localhost:9000/
    

    In addition to standard cross-browser websockets, hookio-webserver itself extends the Hook prototype, which means it can easily connect to other hooks ( or have other hooks connect to it ) to seamlessly broadcast and re-broadcast messages. This means that you can now connect any browser to communicate with your hook.io network.

    When to use?

    hookio-webserver is the bare minimal for component required for opening up a socket.io based websocket server which communicates with hook.io. If you are looking to build a full-featured real-time web application with hook.io, you should use the hook.js project.

    Usage

    as a stand-alone binary

    hookio-webserver
    

    programmatically

        
    var Webserver = require('hook.io-webserver').Webserver;
     
    var webserver = new Webserver({
      name: 'hook.io-webserver',
      port: 9000,
      webroot: './public'
    });
     
    webserver.start();

    Starts up a webserver which takes all incoming HTTP requests and emits the request headers and body to your hook.io network2

    Keywords

    none

    install

    npm i hook.io-webserver

    Downloadsweekly downloads

    24

    version

    0.8.1

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar