Skip to content

do4/RIP

 
 

Repository files navigation

RIP 0.3.4

RIP (REST in peace) is a tool for sending synchroneous REST requests by generating a hidden FORM on-the-fly. It's really useful when developing with frameworks like Slim or Lumy without using synchroneous ajax requests : it just send data like a normal FORM would do.

Install

You can pick the minified library or install it with :

npm install pyrsmk-rip
bower install rip
jam install pyrsmk-rip

Use

RIP handles basic POST, PUT and DELETE requests, but can manage other manual request types.

// API
RIP.POST(<url>, [data]);
RIP.PUT(<url>, [data]);
RIP.DELETE(<url>, [data]);
RIP.map(<type>, <url>, [data]);

// Simple example
RIP.POST('/url');


// Data example
RIP.PUT('/newclient', {
    firstname   : 'Foo',
    lastname    : 'Bar',
    age         : 27,
    children    : [
        'Audrey',
        'Nicholas',
        'Alison'
    ]
});

// Map example
RIP.map('REQUEST_TYPE', '/someurl', {
    foo: 'bar'
});

Please note that requests are using _METHOD POST data attribute, as used in Slim and Lumy. But if you need to change the name of this attribute to __REQUEST__ (per example), you can do this:

RIP.setRequestAttributeName('__REQUEST__');

License

Published under the MIT license.

About

Make REST requests without using synchroneous ajax requests

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 64.3%
  • PHP 18.4%
  • HTML 17.3%