npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

xjrpc

v0.2.0

Published

XJRPC is JSON based RPC with observers and remote promises

Downloads

4

Readme

Extended Json RPC - JavaScript implementation with promises

Calling remote objects

  var remoteCounterServer=session.createRemoteElement('server','counterServer','CounterServer')
  var counter1=remoteCounterServer.getOrCreateCounter('counter1')
  counter1.increment()
  counter1.incrementAndReturn().then(function(res) {
    if(res!=2) throw new Error('wrong counter value')
  },function() {
    throw new Error('Rpc error')
  })

  var counter2=remoteCounterServer.getCounter('counter2')
  counter2.increment()
  counter2.incrementAndReturn().then(function(res) {
    throw new Error('result in place when we expect error')
  },function() {
    counter2.__promise.then(function() {
      throw new Error('result in place when we expect error')
    },function() {
      cb(true)
    })
  })

Object definitions

We need to define what object methods return in order to use them remotely in easy way.

  var serverDefinitions={}

  var Counter=function() {
    this.value=0
  }
  Counter.prototype.$$increment={ noReturn:true }
  Counter.prototype.increment=function() {
    this.value++
    console.log("INCREMENT",this.value)
  }
  Counter.prototype.incrementAndReturn = function() {
    this.value++
    console.log("INCREMENT",this.value)
    return this.value
  }

  serverDefinitions['Counter']=interfaces.createDefinition(Counter.prototype)

  var CounterServer=function() {
    this.counters={}
  }
  CounterServer.prototype.$$getCounter={ returnRemote:'Counter', realms:['client'] }
  CounterServer.prototype.getCounter=function(name) {
    console.log("GET COUNTER",name)
    if(this.counters[name]) {
      return this.counters[name]
    } else throw new Error('counter not found!')
  }
  CounterServer.prototype.$$getOrCreateCounter={ returnRemote:'Counter', realms:['client'] }
  CounterServer.prototype.getOrCreateCounter=function(name) {
    this.counters[name]=this.counters[name] || new Counter()
    return this.getCounter(name)
  }

  serverDefinitions['CounterServer']=interfaces.createDefinition(CounterServer.prototype,'client')

How to use with sockJS

Write in Server:

  /// Include modules:
  var http = require('http')
  var sockjs = require('sockjs')
  var xjrpc = require('xjrpc')

  /// initialize sockjs and xjrpc servers
  var rpcSock = sockjs.createServer()
  var rpcServer = xjrpc.createServer(rpcSock)

  /// Gather class definitions:
  var clientDefinitions ={
    'MyServiceClass':xjrpc.createDefinition(MyServiceClass.prototype,'client')
  }

  /// Create session initializer
  rpcServer.addSessionInitializer('initializerName',function(rpc,welcomeMessage) {
    var myServiceObject=new MyServiceClass(...)
    rpc.share('MyServiceName',myServiceObject)
  })

  /// Share service definitions with client somehow:
  var definitionsJSON=JSON.stringify(clientDefinitions,null,'  ')
  xms.node.fs.writeFile('../client/rpcDefinitions.json',definitionsJSON)
  xms.node.fs.writeFile('../client/rpcDefinitions.jsonp','loadDefinitions('+definitionsJSON+')')
  xms.node.fs.writeFile('../client/rpcDefinitions.js','window.rpcDefinitions='+definitionsJSON)
  
  var server = http.createServer()
  rpcSock.installHandlers(server, {prefix:'/xjrpc'})
  server.listen(9999, '0.0.0.0')

Write in Client:

 <script src="xjrpc.js"></script>
 <script src="rpcDefinitions.js"></script>
 <script>
   var rpcSocket=new XJRPC.sockJsClient.RpcSockJsClient(
     document.location.protocol+'//'+document.location.host+'/xjrpc', true
   )
   var rpcClient=rpcSocket.getRpcClient()
   var rpcSession=rpcClient.createSession(window.rpcDefinitions)
   rpcSession.connect('server',{ /* Welcome messsage for server */ })
   var myRemoteService = rpcSession.createRemoteElement('server','MyServiceName','MyServiceClass')

   /* call your service */
 </script>