@types/nano - npm Package Compare versions

Comparing version 6.4.4 to 6.4.5

nano/index.d.ts

@@ -264,2 +264,4 @@ // Type definitions for nano 6.4
     ): Request;
+    // http://docs.couchdb.org/en/latest/api/database/find.html#db-find
+    find(query: MangoQuery, callback?: Callback<MangoResponse<D>>): Request;
     server: ServerScope;
@@ -1048,4 +1050,89 @@ }
   }
+
+  type MangoValue = number | string | Date | boolean;
+
+  // http://docs.couchdb.org/en/latest/api/database/find.html#selector-syntax
+  interface MangoSelector {
+    [key: string]: MangoSelector | MangoValue | MangoValue[];
+  }
+
+  // http://docs.couchdb.org/en/latest/api/database/find.html#sort-syntax
+  type SortOrder = string | string[] | { [key: string]: 'asc' | 'desc' };
+
+  interface MangoQuery {
+    // JSON object describing criteria used to select documents.
+    selector: MangoSelector;
+
+    // Maximum number of results returned. Default is 25.
+    limit?: number;
+
+    // Skip the first 'n' results, where 'n' is the value specified.
+    skip?: number;
+
+    // JSON array following sort syntax.
+    sort?: SortOrder[];
+
+    // JSON array specifying which fields of each object should be returned. If it is omitted,
+    // the entire object is returned.
+    // http://docs.couchdb.org/en/latest/api/database/find.html#filtering-fields
+    fields?: string[];
+
+    // Instruct a query to use a specific index.
+    // Specified either as "<design_document>" or ["<design_document>", "<index_name>"].
+    use_index?: string | [string, string];
+
+    // Read quorum needed for the result. This defaults to 1.
+    r?: number;
+
+    // A string that enables you to specify which page of results you require. Used for paging through result sets.
+    bookmark?: string;
+
+    // Whether to update the index prior to returning the result. Default is true.
+    update?: boolean;
+
+    // Whether or not the view results should be returned from a “stable” set of shards.
+    stable?: boolean;
+
+    // Combination of update = false and stable = true options.Possible options: "ok", false (default).
+    stale?: 'ok' | false;
+
+    // Include execution statistics in the query response. Optional, default: false.
+    execution_stats?: boolean;
+  }
+
+  interface MangoResponse<D> {
+    // Array of documents matching the search. In each matching document, the fields specified in
+    // the fields part of the request body are listed, along with their values.
+    docs: D[];
+
+    // A string that enables you to specify which page of results you require. Used for paging through result sets.
+    bookmark?: string;
+
+    // Execution warnings
+    warning?: string;
+
+    // Basic execution statistics for a specific request.
+    execution_stats?: MangoExecutionStats;
+  }
+
+  // http://docs.couchdb.org/en/latest/api/database/find.html#execution-statistics
+  interface MangoExecutionStats {
+    // Number of index keys examined. Currently always 0.
+    total_keys_examined: number;
+
+    // Number of documents fetched from the database / index, equivalent to using include_docs = true in a view.
+    total_docs_examined: number;
+
+    // Number of documents fetched from the database using an out - of - band document fetch.
+    // This is only non - zero when read quorum > 1 is specified in the query parameters.
+    total_quorum_docs_examined: number;
+
+    // Number of results returned from the query.
+    results_returned: number;
+
+    // Total execution time in milliseconds as measured by the database.
+    execution_time_ms: number;
+  }
 }
 
 export = nano;

nano/package.json

 {
     "name": "@types/nano",
-    "version": "6.4.4",
+    "version": "6.4.5",
     "description": "TypeScript definitions for nano",
@@ -25,7 +25,8 @@ "license": "MIT",
     "dependencies": {
+        "@types/events": "*",
         "@types/request": "*",
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "3e47dbc5cc0559a553718833adc2ba840490ac92786f4640b4c75e3cd9d636d0",
+    "typesPublisherContentHash": "4c4c696162a5c2a09152652f7806810b8528869ff06cb4b5c3023d16d7372f33",
     "typeScriptVersion": "2.3"
 }

nano/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Thu, 09 Nov 2017 09:38:04 GMT
+ * Last updated: Wed, 17 Jan 2018 22:17:28 GMT
  * Dependencies: events, request, node
@@ -14,0 +14,0 @@ * Global values: none

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

42843

increased by5.53%

Lines of code

920

increased by7.35%

Worsened metrics

Dependency count

3

increased by50%

Dependency changes

• + Added@types/events@*

• + Added@types/events@3.0.3(transitive)