PouchDB Sublime snippets

PouchDB snippets for Sublime Text.

PouchDB is an open-source JavaScript database inspired by Apache CouchDB that is designed to run well within the browser. Was created to help web developers build applications that work as well offline as they do online.

To install through Package Control, search for PouchDB. If you still don't have Package Control in Sublime Text, go get it. If you insist to not install it, you can download the package and put it manually inside your Pacakages directory. It should work but will not update automatically.

Snippets

To trigger a snippet just put a pdb- followed by it's name, like so:

Create a database

trigger: pdb-new⇥

var db = new PouchDB('dbName', options);

Delete a database

trigger: pdb-destroy⇥

db.destroy('dbName', function(err, res) {
    // your code goes here
});

Create a new document or update an existing document

trigger: pdb-put⇥

db.put(doc, function(err, res) {
    // your code goes here
});

Create a new document and let PouchDB generate an _id for it

trigger: pdb-post⇥

db.post(doc, function(err, res) {
    // your code goes here
});

Fetch a document

trigger: pdb-get⇥

db.get('doc', function(err, res) {
    // your code goes here
});

Delete a document

trigger: pdb-remove⇥

db.remove('doc', function(err, res) {
    // your code goes here
});

Create/update a batch of documents

trigger: pdb-bulkDocs⇥

db.bulkDocs(docs, function(err, res) {
    // your code goes here
});

Fetch multiple documents

trigger: pdb-allDocs⇥

db.allDocs(options, function(err, res) {
    // your code goes here
});

Listen to database changes

trigger: pdb-changes⇥

db.changes(options);

Replicate a database

trigger: pdb-replicate⇥

db.replicate.type(remoteDB, options);

Sync a database

trigger: pdb-sync⇥

var sync = PouchDB.sync(src, target, options);

Save an attachment

trigger: pdb-putAttachment⇥

db.putAttachment(docId, attachmentId, rev, doc, type, function(err, res) {
    // your code goes here
});

Get an attachment

trigger: pdb-getAttachment⇥

db.getAttachment(docId, attachmentId, options, function(err, res) {
    // your code goes here
});

Delete an attachment

trigger: pdb-removeAttachment⇥

db.removeAttachment(docId, attachmentId, rev, function(err, res) {
    // your code goes here
});

Query the database

trigger: pdb-query⇥

db.query(fun, options, function(err, res) {
    // your code goes here
});

Get database information

trigger: pdb-info⇥

db.info(function(err, res) {
    // your code goes here
});

Compact the database

trigger: pdb-compact⇥

db.compact(options, function(err, res) {
    // your code goes here
});

Document revisions diff

trigger: pdb-revsDiff⇥

db.revsDiff(diff, function(err, res) {
    // your code goes here
});

Events

trigger: pdb-event⇥

PouchDB.on('event', function(dbName) {
    // your code goes here
});

Plugins

trigger: pdb-plugin⇥

PouchDB.plugin({
    methodName: myFunction
});

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m "Add some feature"
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :)

English is the universal language nowadays, so please don't create or comment on issues using another language.

History

For detailed changelog, see Releases.

License

MIT License © Breno Polanski