Naval Pilgrim's Mayflower

    remote-context

    0.2.1 • Public • Published

    view on npm Build Status Dependency Status codecov npm license

    Remote-context

    Create a virtual context and share it remotely with other peers via ANY stream object 💫.

    Using only a Duplex stream such as TCP soocket, WebSocket or even WebRTC DataChannel with this library you can just share your code with other peers without worrying for API interfaces or RPC integration. Your users will be able to use your code remotely exactly as you write it. Including calling functions with callbacks, Promises, class inheritance and more.

    This library is the core of remote-lib module.

    Install

    npm install remote-context
    

    Usage

    On the server

    const net = require('net');
     
    // Get the context and the environment
    const { Context } = require('remote-context');
    const envContext = require('remote-context/envs/es6-unstable');
     
    // Create a new context under ES6 environment.
    // You can put any object, class or instance under the context and it will be proxied to the
    // remote peer automatically
    const context = new Context(envContext, {
      // Static vars
      foo: 'bar',
     
      // Dynamic functions
      getRandom: () => Math.random(),
     
      // Async functions
      getData: () =>
        new Promise(resolve =>
          setTimeout(() => resolve({ data: 'Tada!' }), 100),
        ),
     
      // Classes and objects
      myThings: new Set(['car', 'keys', 'pizza']),
    });
     
    // Create a server and serve each client the context remotely
    const server = net.createServer(socket => {
      context.remote(socket);
    });
     
    // Bind on port 3000
    server.listen(3000);

    On the client

    const net = require('net');
     
    // Get the context and the environment
    const { Context } = require('remote-context');
    const envContext = require('remote-context/envs/es6-unstable');
     
    // Connect to the server and get a stream
    const socket = net.createConnection(3000);
     
    // Create the remote context
    const clientContext = new Context(envContext);
    const remoteContext = clientContext.remote(socket);
     
    // Get the remote "foo"
    remoteContext.fetch('foo').then(value => {
      // value === 'bar'
    });
     
    // Run the remote function "getRandom"
    remoteContext.fetch('getRandom')().then(value => {
      // `value` is random number
    });
     
    // Run the remote async function "getData"
    remoteContext.fetch('getData')().then(value => {
      // value === { data: 'Tada!' }
    });
     
    // Get remote instance set "myThings"
    remoteContext.fetch('myThings').then(async set => {
      set instanceof Set; // true
      
      // Access getters and data properties instantly
      set.size; // 3
     
      // Call methods with async promises
      await set.has('keys'); // true
      await set.has('cat'); // false
     
      // Change the remote instance
      await set.add('dog');
      await set.has('dog'); // true
    });

    Supported Environments

    Remote-context is currently supporting only limited number of environment contexts. To use an environment you should require it explicitly:

    const envContext = require('remote-context/envs/ENV_NAME');

    When ENV_NAME is the required environment name.

    Name Status Description
    es6-unstable AVAILABLE A development version of ES6 context. This environment consider unstable and may change over the versions.
    node6-unstable IN_DEVELOPMENT This environment will include all Node.js version 6 context. This environment consider unstable and may change over the versions.

    API Reference

    This module is a part of the remote-lib library.

    Here is the relevant documentation for this module:




    © 2017 Moshe Simantov

    Licensed under the Apache License, Version 2.0.

    Install

    npm i remote-context

    DownloadsWeekly Downloads

    2

    Version

    0.2.1

    License

    Apache-2.0

    Last publish

    Collaborators

    • moshe