Socket
Socket
Sign inDemoInstall

nogap

Package Overview
Dependencies
Maintainers
1
Versions
51
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

nogap

The NoGap framework delivers RPC + asset management + some other good stuff for Host <-> Client comunication.


Version published
Weekly downloads
57
increased by533.33%
Maintainers
1
Weekly downloads
 
Created
Source

NoGap

The NoGap framework delivers RPC + asset management + some other good stuff for enjoyable Host <-> Client architecture development.

This module is called No Gap because it removes the typical gap that exists between host and client and that makes a client<->server architecture so cumbersome to develop.

NoGap's primary use case is to develop rich client-side applications while alleviating the typical hassles of doing so.

Have a look at the Samples for reference.

Installation

  • Install Node
    • Make sure to select Add to PATH during GUI-based installation.
  • Open a command line
    • On Windows: Press Ctrl+R -> Type cmd -> Enter
  • Run: npm install nogap
  • Done.

Samples

HelloWorld

var NoGapDef = require('nogap').Def;

module.exports = NoGapDef.component({
	Client: NoGapDef.defHost(function(Tools, Instance, Context) {
		return {
			initClient: function() {
				document.body.innerHTML = 'Hello World!';
			}
		};
	});
});

Concepts

  • Get the NoGap module's Def helper: var NoGapDef = require('nogap').Def;
  • Define a new component: NoGapDef.component({ ... });
  • Add a Client definition to the component: Client: NoGapDef.defClient(function(Tools, Instance, Context) { ... })
  • Add initClient method to Client

What is the trick?

  • The Client code is automatically deployed to the client
  • initClient is then automatically called on the client, right after installation

TwoWayStreet

var NoGapDef = require('nogap').Def;

NoGapDef.component({
    Host: NoGapDef.defHost(function(SharedTools, Shared, SharedContext) {
        var iAttempt = 0;

        return {
            Public: {
                tellClientSomething: function() {
                    this.client.showHostMessage('We have exchanged ' + ++iAttempt + ' messages.');
                }
            }
        };
    }),

    Client: NoGapDef.defClient(function(Tools, Instance, Context) {
        return {
            initClient: function() {
                window.clickMe = function() {
                    document.body.innerHTML +='Button was clicked.<br />';
                    this.host.tellClientSomething();
                }.bind(this);

                document.body.innerHTML += '<button onclick="window.clickMe();">Click Me!</button><br />';
            },

            Public: {
                showHostMessage: function(msg) {
                    document.body.innerHTML +='Server said: ' + msg + '<br />';
                }
            }
        };
    })
});

Concepts

  • Add a Client definition to the component: Client: NoGapDef.defClient(function(Tools, Instance, Context) { ... })
  • Client.initClient
  • Add a Host definition to the component: Host: NoGapDef.defHost(function(SharedTools, Shared, SharedContext) { ... })
  • Host.Public
  • Client.Public

What is the trick?

  • this.host gives us an object on which we can call Public methods on the host
    • For example, we can call tellClientSomething which is a method that was defined in Host.Public
  • Once the host receives our request, it calls this.client.showHostMessage
  • Note:
    • Client: this.host vs.
    • Host: this.client

TwoWayStreetAsync

Now that our code keeps growing and you are starting to get the picture, let us just focus on code snippets from now on.

Imagine the server had to do an asynchronous operation in tellClientSomething. For example, it needs to read a file, or get something from the database.

tellClientSomething: function() {
    this.Tools.keepOpen();

    // wait 500 milliseconds before replying
    setTimeout(function() {
        this.client.showHostMessage('We have exchanged ' + ++iAttempt + ' messages.');
        this.Tools.flush();
    }.bind(this), 500);
}

New Concepts

  • We need to perform an asynchronous request whose result is to be sent to the other side:
    • In that case, first call this.Tools.keepOpen(), so the client connection will not be closed automatically
    • Once you sent everything to the client, call this.Tools.flush()

CodeSharingWithBase

tellClientSomething: function() {
    this.Tools.keepOpen();

    // wait 500 milliseconds before replying
    setTimeout(function() {
        this.client.showHostMessage('We have exchanged ' + ++iAttempt + ' messages.');
        this.Tools.flush();
    }.bind(this), 500);
}

New Concepts

  • We need to perform an asynchronous request whose result is to be sent to the other side:
    • In that case, first call this.Tools.keepOpen(), so the client connection will not be closed automatically
    • Once you sent everything to the client, call this.Tools.flush()

Getting Started

This tutorial is aimed at those who are new to NoGap, and new to Node in general. It should help you bridge the gap from the Code Snippets to a real-world application.

.
+-- components/
+-- lib/
+-- pub/
+-- package.json
+-- appConfig.js
+-- app.js

Let's have a look at the different files and folders:

package.json

This is the standard Node configuration file. Here you can declare your app's basic metadata and, most importantly, your dependencies. If you need one of the thousands over thousands of publicly available Node modules, two steps are required:

  1. add their name and your preferred version to dependencies
  2. Run npm install

Done. Now the new module is available in your code via:

var someModule = require('some-module');

where some-module is the name you gave it in the package.json file.

Check out https://www.npmjs.org/ to see all available modules.

components/

This folder contains your NoGap components, and possibly (some of) their assets. You can name it anything you want. NOTE: Placing assets (such as *.html templates, stylesheets, images etc.) next to code is actually good style, if it supports modularization. If your components are mostly self-contained, you can easily move their whole folder, including their assets, to deploy them in other places.

appConfig.js

This is your custom configuration file. You can name it anything you want. It contains some basic constant data that your application needs, such as database login and other setup information. The following is an example of a NoGap configuration. It requires at least three entries:

  • baseFolder
    • This is the folder, relative to your application (e.g. app.js) where you defined all NoGap components.
  • publicFolder
    • The folder to find all client asset files that cannot be found relative to a component.
    • Usually this is used to store client-only and shared javascript libraries that do not have NoGap support.
  • files
    • The actual component files (sans ".js"). Whenever you add a component, don't forget to list it here!
"nogap": {
    "baseFolder"   : "components",
    "publicFolder" : "pub",
    "files"        : [
        // list all components here:

        // utilities
        "ValidationUtil",

        // pages for guests
        "Guest",

        // pages for users
        "Main",
        "Home"
    ]
}

There are more, optional parameters. Documentation will come soon.

app.js

This defines your actual application. You can name it anything you want. Usually this file only does two things:

  1. Setup your app
  2. Start your express server

Express is the standard Node way of starting a web server and let clients connect. Once it is running you can connect to it with your browser on the specified port.

With NoGap, we add one more job to it:

  1. Setup your app
  2. Initialize NoGap
  3. Start your express server

FAQs

Package last updated on 03 Jun 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc