couch-init2

Installation

# ESM
npm install couch-init2
# CommonJS
npm install couch-init2@5

How To

import couchInit from 'couch-init2'
const dbUrl = 'http://username:password@localhost:5984'
const dbsList = [
 {
 name: 'dbname1',
 designDocs: ['designdoc1']
 },
 {
 name: 'dbname2',
 designDocs: ['designdoc2', 'designdoc3']
 },
 {
 name: 'dbname3',
 designDocs: []
 }
 ]
// Path to the folder where design docs can be found on the model `${designDocName}.json`
// If a design doc file from the list is missing, it will be created with a basic design doc structure
// If a design doc file changed, the database design doc will be updated
const designDocFolder = '/path/to/your/design/docs/folder'
const { ok, operations } = await couchInit(dbUrl, dbsList, designDocFolder)
console.log('ok', res.ok)
console.log('operations', res.operations)
// dbs were successfully initialized!
// time to start your server or whatever crazy thing you're building :)

Design docs formats

json

{
 "_id": "_design/example",
 "language": "javascript",
 "views": {
 "byFoo": {
 "map": "function (doc) {\n if (doc.foo) emit(doc.foo, 1)\n}"
 }
 }
}

js

export default {
 byFoo: {
 map: function (doc) {
 if (doc.foo) emit(doc.foo, 1)
 },
 reduce: function(keys, values) {
 return values.reduce((a, b) => a + b, 0)
 },
 },
 byBar: {
 // The function stringification won't be able to detect variables in scope.
 // In this case, you have to pass the function and its dependencies as a string.
 map: `
 const double = num => num * 2

 function (doc) {
 if (doc.foo) emit(doc.foo, double(1))
 }`,
 },
 byBuzz: {
 // Alternatively, an array of functions can be passed to preserve text editor
 // features such as syntax highlighting or linting
 map: [
 function double (num) { num * 2 },
 function (doc) {
 if (doc.example) emit(doc.example, double(1))
 }
 ]
 },
}

What it does

See also