Git Product home page Git Product logo

bp-connector-helper's Introduction

Code Climate Build Status Dependency Status

Synopsis

Helper for the BigPlans Connector modules

helper.q

kriskowal/q library

See more at [ https://github.com/kriskowal/q ]

helper.request

Wrapper around the mikeal/request

See more at [ https://github.com/mikeal/request ]

helper.promise

Used to create promises

var hook1 = helper.promise(function(done) {
  // ...
  done();
});

var hook2 = helper.promise(function(done) {
  //...
  done();
});

hook1.then(hook2).done(function() {
  //...
});

helper.applyParams

Used to apply query string params for the URI

applyParams('http://host.tld/user/%{userId}/account', { userId: 1 });
//  => 'http://host.tld/user/1/account'

helper.translator

Translator object methods: ruleFor(name, ruleFunc), to(name, object)

translator.ruleFor('goal', function(ticket) {
  return {
    title:        ticket.title,
    description:  ticket.body
  };
});

translator.to('goal', ticket);
  //=> { title: <ticket.title>, description: <ticket.body> };

helper.decorator

JSEND decorator object methods: toJsend(obj || err), toJsendError(err || String)

var result = { name: 'goalName' };
decorator.toJsend(result);
  //=> { status: 'success', data: { name: 'goalName' }, message: '' }

var err = 'No response provided';
decorator.toJsendError(err);
  //=> { status: 'error', data: {}, message: 'No response provided' }

decorator.toJsend(err);
  //=> { status: 'fail', data: {}, message: 'No response provided' }

var err = new Error('No response provided');
decorator.toJsend(err);
  //=> { status: 'error', data: {}, message: 'No response provided' }

helper.respondTo

Captures provided object and transforms it to JSEND

Wrapper around the decorator.toJsend

Is a shortcut for callback( decorator.toJsend( { id: 1 } ) )

var respondWith = respondTo(callback);
respondWith({ id: 1 });
  //=> callback(decorator.toJsend({ id: 1 ))

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.