- Notifications
You must be signed in to change notification settings - Fork0
License
sysdynetechnologies/strong-remoting
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Objects (and, therefore, data) in Node applications commonly need to be accessible by other Node processes, browsers, and even mobile clients. Strong remoting:
- Makes local functions remotable, exported over adapters.
- Supports multiple transports, including custom transports.
- Manages serialization to JSON and deserialization from JSON.
- Supports multiple client SDKs, including mobile clients.
For higher-level transports, such as REST and Socket.IO, existing clients will work well. If you want to be able to swap out your transport, use one of our supported clients. The same adapter model available on the server applies to clients, so you can switch transports on both the server and all clients without changing your application-specific code.
$ npm install strong-remoting
The following example illustrates how to set up a basic strong-remoting server with a single remote method, user.greet.
// Create a collection of remote objects.varremoting=require('../');varSharedClass=remoting.SharedClassvarremotes=remoting.create();// define a class-like object (or constructor)functionUser(){}User.greet=function(fn){fn(null,'hello, world!');}// create a shared class to allow strong-remoting to map// http requests to method invocations on your classvaruserSharedClass=newSharedClass('user',User);// Tell strong-remoting about your greet methoduserSharedClass.defineMethod('greet',{isStatic:true,// not an instance methodreturns:[{arg:'msg',type:'string'// define the type of the callback arguments}]});// Expose it over the REST transport.require('http').createServer(remotes.handler('rest')).listen(3000);
Then, invokeUser.greet() easily withcurl (or any HTTP client)!
$ curl http://localhost:3000/user/greet?str=helloResult:
{ "msg": "hello world"}Most Node applications expose a remotely-available API. Strong-remoting enables you to build your app in vanilla JavaScript and export remote objects over the network the same way you export functions from a module. Since they're just plain JavaScript objects, you can always invoke methods on your remote objects locally in JavaScript, whether from tests or other, local objects.
Collections that are the result of require('strong-remoting').create() are responsible for binding their remote objects to transports, allowing you to swap out the underlying transport without changing any of your application-specific code.
Adapters provide the transport-specific mechanisms to make remote objects (and collections thereof) available over their transport. The REST adapter, for example, handles an HTTP server and facilitates mapping your objects to RESTful resources. Other adapters, on the other hand, might provide a less opionated, RPC-style network interface. Your application code doesn't need to know what adapter it's using.
Hooks enable you to run code before remote objects are constructed or methods on those objects are invoked. For example, you can prevent actions based on context (HTTP request, user credentials, and so on).
// Do something before any hook is executedremotes.authorization=function(ctx,next){if(checkContext(ctx)){// allownext();}else{// denyvarerr=newError('denied!');err.statusCode=401;next(err);}}// Do something before our `user.greet` example, earlier.remotes.before('user.greet',function(ctx,next){if((ctx.req.param('password')||'').toString()!=='1234'){next(newError('Bad password!'));}else{next();}});// Do something before any `user` method.remotes.before('user.*',function(ctx,next){console.log('Calling a user method.');next();});// Do something before a `dog` instance method.remotes.before('dog.prototype.*',function(ctx,next){vardog=this;console.log('Calling a method on "%s".',dog.name);next();});// Do something after the `speak` instance method.// NOTE: you cannot cancel a method after it has been called.remotes.after('dog.prototype.speak',function(ctx,next){console.log('After speak!');next();});// Do something before all methods.remotes.before('**',function(ctx,next,method){console.log('Calling:',method.name);next();});// Modify all returned values named `result`.remotes.after('**',function(ctx,next){ctx.result+='!!!';next();});
See the before-after example for more info.
Strong-remoting supports methods that expect or return Readable and Writeable streams. This enables you to stream raw binary data such as files over the network without writing transport-specific behavior.
For example, the following code exposes a method of thefs Remote Object,fs.createReadStream, over the REST adapter:
// Create a Collection.varremotes=require('strong-remoting').create();// Share some fs module code.varfs=remotes.exports.fs=require('fs');// Specifically export the `createReadStream` function.fs.createReadStream.shared=true;// Describe the arguments.fs.createReadStream.accepts={arg:'path',type:'string'};// Describe the stream destination.fs.createReadStream.http={// Pipe the returned `Readable` stream to the response's `Writable` stream.pipe:{dest:'res'}};// Expose the Collection over the REST Adapter.require('http').createServer(remotes.handler('rest')).listen(3000);
Then you can invoke fs.createReadStream() using curl as follows:
$ curl http://localhost:3000/fs/createReadStream?path=some-file.txtAbout
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.