0.0.1-pre1 • Published 10 years ago
mongo-ticket v0.0.1-pre1
mongo-ticket
simple implementation of a single use "ticket", built with mongodb and node.js
Installation
npm install mongo-ticket
Options
autoConnect
whether you want mongo-ticket to immediately connect to the database. If set to false you will have to call the connect method directly (default: true)collection
the name to use for the collection that will store tickets (default: 'mongoTicket')stringify
whether you want mongo-ticket totry
to useJSON.stringify
andJSON.parse
when storing and retrieving tickets (default: true)
Usage
var mongoTicket = new MongoTicket('mongodb://localhost:27017/mongo-ticket', function (err, db) {
if (err) // ...
mongoTicket.set('qwerty', 'keyboard cat', function (err) {
// ...
});
});
Later on...
mongoTicket.get('qwerty', function (err, val) {
if (err) // ....
console.log(val); // => 'keyboard cat'
})
Methods
connect(callback)
connects to the database with the provided mongodb uri. This is called for you unless to specifyautoConnect: false
in the optionsget(ticket, callback)
gets a ticket and removes it if found. The arity of the callback is (error, ticketValue), where error is null unless something went wrong, and ticketValue is the (optionally parsed) value stored in the ticket.set(ticket, ticketValue, callback)
sets ticket with the given value. The callback is passed directly to the mongodb driver's insert method
0.0.1-pre1
10 years ago
0.0.1-pre
10 years ago