Code Monkey home page Code Monkey logo

datadiff-node's Introduction

Datadiff Node Module

This is a simple node lib that creates a request client and sends a commit to the Datadiff API.

Installation

You can git clone this repo or simply copy and paste the datadiff.js file.

###Install with NPM### npm install datadiff --save

Usage

  1. Create a Datadiff account.
  2. Create a data source and obtain it's API credentials.
  3. Require the node module.
  4. Execute a commit to the Datadiff API.

The library sends a commit to the API via the commit method with the following arguments:

  1. The data model (object)
  2. The name of the collection/table
  3. The command (created|updated|deleted)
  4. The unique ID field. i.e _id for Mongo.
  5. A meta data object (optional)
  6. A callback function (optional)

Committing an update to the Datadiff API

In this example a customer has just updated their account.

var Datadiff = require('datadiff'),
    diff = new Datadiff({key: '**********', secret: '**********'});

...

// update account object
account.update(data, function(err, acc) {
	
	if(err) {
		// handle error
	}
	
	diff.commit(acc.toObject(), 'accounts', 'updated', '_id', {action: 'updated account', src: 'accounts page on software'});
	
});

datadiff-node's People

Contributors

theninthnode 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.