1.5.8 • Published 10 years ago

datamcfly v1.5.8

Weekly downloads
5
License
ISC
Repository
github
Last release
10 years ago

Simple node.js REST client for DataMcFly.com


NPM datamcfly

  • create on your desktop empty directory with name: website
  • open terminal and find this directory: cd /Desktop/website/
  • write and run on terminal:
$ npm install datamcfly

Methods

/*
    DataMcFly constructor
    @database {String}
    @collection {String}
    @key {String} :: get your key from http://app.datamcfly.com/
*/
DataMcFly(database, collection, key);
 
/*
    Usage / Constructor
    @database {String}
    @collection {String}
    @key {String} :: get your key from http://app.datamcfly.com/
    return {DataMcFly};
*/
require('datamcfly').init(database, collection, key);
 
/*
    All collection in database
    @cb {Function} :: function(error, object)
    return {DataMcFly}
*/
datamcfly.collections(cb);
 
/*
    Get all documents
    @params {Object}
    @cb {Function} :: function(error, object)
    return {DataMcFly}
*/
datamcfly.get(params, cb);
datamcfly.documents(params, cb);
 
/*
    Listen for changes via push server
    @event {String}
    @cb {Function} :: function(error, data)
    return {DataMcFly}
*/
datamcfly.on(event, cb);

/*
    Push a change to push server
    @event {String}
    @message {String}
*/
datamcfly.trigger(event, message);
 
// Params options
// q<query> :: restrict results by the specified JSON query
// q = {} :: object
// where = {} :: object
// query = {} :: object
 
// s<sort> :: specify the order in which to sort each specified field (1- ascending; -1 - descending)
// s = {} :: object
// sort = {} :: object
// asc = ['name', 'age'] :: array
// desc = ['name', 'age'] :: array
 
// f<set of fields> :: specify the set of fields to include or exclude in each document (1 - include; 0 - exclude)
// f = {} :: object
// include = ['name', 'age'] :: array
// exclude = ['name', 'age'] :: array
 
// c<boolean> :: return the result count for this query
// c = true :: boolean
// count = true :: boolean
 
// fo<boolean> :: return a single document from the result set (same as findOne() using the mongo shell
// fo = true :: boolean
// first = true :: boolean
 
// sk<num results to skip> :: specify the number of results to skip in the result set; useful for paging
// sk = 10 :: number
// skip = 10 :: number
 
// l<limit> :: specify the limit for the number of results (default is 1000)
// l = 10 :: number
// take = 10 :: number
// max = 10 :: number
// top = 10 :: number
// limit = 10 :: number
 
// --------
// UPDATING
// --------
 
// m<boolean> :: update all documents
// m = true :: boolean
// all = true :: boolean
// update-all = true :: boolean
 
// u<boolean> :: insert the document defined in the request body if none match the specified query
// u = true :: boolean
// upsert = true :: boolean
 
var params = { where: { age: 28 }, asc: ['age'] };
 
datamcfly.documents('users', params, function(data) {
     
});
 
/*
    Insert document / documents
    @collection {String}
    @documents {String, Object or Object array}
    @cb {Function} :: function(error, object)
    return {DataMcFly}
*/
datamcfly.set(documents, cb);
datamcfly.push(documents, cb);
datamcfly.insert(documents, cb);
 
/*
    Update document / documents
    @collection {String}
    @condition {Object or Object array}
    @params {Object}
    @cb {Function} :: function(error, object)
    return {DataMcFly}
*/
datamcfly.update(condition, params, cb);
 
/*
    Find document by Id
    @collection {String}
    @id {String or Number}
    @cb {Function} :: function(error, object)
    return {DataMcFly}
*/
datamcfly.findId(id, cb);
 
/*
    Update document by Id
    @collection {String}
    @id {String or Number}
    @document {Object}
    @cb {Function} :: function(error, object)
    return {DataMcFly}
*/
datamcfly.updateId(id, document, cb);
 
/*
    Delete document by Id
    @collection {String}
    @id {String or Number}
    @cb {Function} :: function(error, object)
    return {DataMcFly}
*/
datamcfly.deleteId(id, cb);
 

1.5.8

10 years ago

1.5.7

10 years ago

1.5.6

10 years ago

1.5.5

10 years ago

1.5.4

10 years ago

1.5.3

10 years ago

1.5.2

10 years ago

1.5.1

10 years ago

1.5.0

10 years ago

1.4.9

10 years ago

1.4.8

10 years ago

1.4.7

10 years ago

1.4.6

10 years ago

1.4.4

10 years ago

1.4.3

10 years ago

1.4.2

10 years ago

1.4.1

10 years ago

1.4.0

10 years ago

1.3.6

10 years ago

1.3.5

11 years ago

1.3.4

11 years ago

1.3.3

11 years ago

1.3.2

11 years ago

1.3.1

11 years ago

1.3.0

11 years ago

1.2.9

11 years ago

1.2.8

11 years ago

1.2.7

11 years ago

1.2.6

11 years ago

1.2.5

11 years ago

1.2.4

11 years ago

1.2.3

11 years ago

1.2.2

11 years ago

1.2.1

11 years ago

1.2.0

11 years ago

1.1.9

11 years ago

1.1.8

11 years ago

1.1.7

11 years ago

1.1.6

11 years ago

1.1.5

11 years ago

1.1.3

11 years ago

1.1.2

11 years ago

1.1.1

11 years ago