Git Product home page Git Product logo

retort-json's Introduction

retort-json

A retort that defaults to JSON responses

retorter

A request/response wrapper for use at the very last part of your routing for JSON APIs.

usage

Say you have a route:

    "abc/`id`": function(request, response, tokens){

    }

To respond ok with some data in the form of JSON, you would usually have to:

    "abc/`id`": function(request, response, tokens){
        someFunction(tokens.id, function(error, data){
            response.end(JSON.stringify(data));
        });
    }

Which isn't so bad, but then handle the error case

    "abc/`id`": function(request, response, tokens){
        someFunction(function(error, data){
            if(error){
                //Log maybe?
                console.log(error);

                // set the 500 code
                response.statusCode = 500;

                // API error, so stringify it.
                response.end(JSON.stringify(error));

                return;
            }

            response.end(JSON.stringify(data));
        });
    }

With JSON retorter, a set of actions has been defined that can be performed on a request, and use them to respond without having to do all that setup every time.

    "abc/`id`": retorter(function(retort, tokens){
        someFunction(tokens.id, function(error, data){
            if(error){
                return retort.error(error);
            }

            retort.ok(data);
        });
    })

Which, if you use something like wraperr can be even tighter:

    "abc/`id`": retorter(function(retort, tokens){
        someFunction(tokens.id, wraperr(retort.ok, retort.error));
    })

You can also get access to the origininal request and response objects via the passed in retort object

    "abc/`id`": retorter(function(retort, tokens){

        retort.request

        retort.response

    })

retort-json's People

Contributors

mauricebutler avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.