@teammaestro/node-couchdb-client/couchdb.d.ts

This typescript module is designed to do handle the communication between NodeJS and CouchDB

import { CouchDbOptions, CouchDbResponse } from './index';
export declare class CouchDb {
    private host;
    private port;
    private auth;
    private logging;
    defaultDatabase: string;
    constructor(options?: CouchDbOptions.Connection);
    private createQueryString(queryObj?);
    private readonly defaultRequestOptions;
    private request<T>(options?);
    private statusCode(statusCodes, status);
    getInfo(): PromiseLike<CouchDbResponse.Info>;
    getDatabases(): PromiseLike<string[]>;
    getDatabase(dbName?: string): PromiseLike<CouchDbResponse.DatabaseInfo>;
    createDatabase(dbName?: string): PromiseLike<CouchDbResponse.Generic>;
    checkDatabaseExists(dbName?: string): PromiseLike<boolean>;
    deleteDatabase(dbName?: string): PromiseLike<CouchDbResponse.Generic>;
    updateDatabaseSecurity(options: {
        dbName?: string;
        admins: {
            names?: string[];
            roles?: string[];
        };
        members: {
            names?: string[];
            roles?: string[];
        };
    }): PromiseLike<CouchDbResponse.Generic>;
    createUser(options: {
        username: string;
        password: string;
        roles?: string[];
    }): PromiseLike<CouchDbResponse.Create>;
    checkUserExists(username: string): PromiseLike<boolean>;
    getUser(username: string): PromiseLike<CouchDbResponse.Document>;
    findDocuments(options: {
        dbName?: string;
        findOptions: CouchDbOptions.FindOptions;
    }): PromiseLike<CouchDbResponse.Find>;
    getDocuments(options: {
        dbName?: string;
        options?: CouchDbOptions.FindAllOptions;
    }): PromiseLike<CouchDbResponse.AllDocuments>;
    getDocument(options: {
        docId: string;
        dbName?: string;
    }): PromiseLike<CouchDbResponse.Document>;
    checkDocumentExists(options: {
        dbName?: string;
        docId: string;
    }): PromiseLike<boolean>;
    copyDocument(options: {
        docId: string;
        newDocId: string;
        dbName?: string;
    }): PromiseLike<CouchDbResponse.Create>;
    createDocument(options: {
        doc: any;
        docId?: string;
        dbName?: string;
    }): PromiseLike<{}>;
    upsertDocuments(options: {
        docs: any[];
        dbName?: string;
    }): PromiseLike<CouchDbResponse.Create[]>;
    updateDocument(options: {
        dbName?: string;
        docId: string;
        rev: string;
        updatedDoc: any;
    }): PromiseLike<CouchDbResponse.Create>;
    deleteDocument(options: {
        dbName?: string;
        docId: string;
        rev: string;
    }): PromiseLike<CouchDbResponse.Generic>;
    getUuids(count?: number): PromiseLike<string[]>;
    getDesignDocument(options: {
        dbName?: string;
        docId: string;
        options?: CouchDbOptions.DocumentOptions;
    }): PromiseLike<{}>;
    getDesignDocumentInfo(options: {
        dbName: string;
        docId: string;
    }): PromiseLike<{}>;
    createDesignDocument(options: {
        dbName?: string;
        doc: any;
        docId: string;
    }): PromiseLike<{}>;
    deleteDesignDocument(options: {
        dbName?: string;
        docId: string;
        rev: string;
    }): PromiseLike<{}>;
    getDocumentView(options: {
        dbName?: string;
        docId: string;
        viewName: string;
        options?: CouchDbOptions.DocumentOptions;
    }): PromiseLike<{}>;
    getIndexes(dbName?: string): PromiseLike<{}>;
    createIndex(options: {
        dbName?: string;
        index: any;
        name?: string;
    }): PromiseLike<{}>;
    deleteIndex(options: {
        dbName?: string;
        docId: string;
        indexName: string;
    }): PromiseLike<{}>;
}