Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@types/nedb
Advanced tools
@types/nedb - npm Package Compare versions
Comparing version 0.0.21-alpha to 0.0.22-alpha
252
index.d.ts
@@ -6,151 +6,149 @@ // Type definitions for NeDB | ||
| declare module "nedb" { | ||
| declare class NeDBDataStore { | ||
| class NeDBDataStore { | ||
| constructor(); | ||
| constructor(path:string); | ||
| constructor(options:NeDB.DataStoreOptions); | ||
| constructor(); | ||
| constructor(path:string); | ||
| constructor(options:NeDB.DataStoreOptions); | ||
| persistence:NeDB.Persistence; | ||
| persistence:NeDB.Persistence; | ||
| /** | ||
| * Load the database from the datafile, and trigger the execution of buffered commands if any | ||
| */ | ||
| loadDatabase(cb?:(err:Error)=>void):void; | ||
| /** | ||
| * Load the database from the datafile, and trigger the execution of buffered commands if any | ||
| */ | ||
| loadDatabase(cb?:(err:Error)=>void):void; | ||
| /** | ||
| * Get an array of all the data in the database | ||
| */ | ||
| getAllData():Array<any>; | ||
| /** | ||
| * Get an array of all the data in the database | ||
| */ | ||
| getAllData():Array<any>; | ||
| /** | ||
| * Reset all currently defined indexes | ||
| */ | ||
| resetIndexes(newData:any):void; | ||
| /** | ||
| * Reset all currently defined indexes | ||
| */ | ||
| resetIndexes(newData:any):void; | ||
| /** | ||
| * Ensure an index is kept for this field. Same parameters as lib/indexes | ||
| * For now this function is synchronous, we need to test how much time it takes | ||
| * We use an async API for consistency with the rest of the code | ||
| * @param {String} options.fieldName | ||
| * @param {Boolean} options.unique | ||
| * @param {Boolean} options.sparse | ||
| * @param {Function} cb Optional callback, signature: err | ||
| */ | ||
| ensureIndex(options:NeDB.EnsureIndexOptions, cb?:(err:Error)=>void):void; | ||
| /** | ||
| * Ensure an index is kept for this field. Same parameters as lib/indexes | ||
| * For now this function is synchronous, we need to test how much time it takes | ||
| * We use an async API for consistency with the rest of the code | ||
| * @param {String} options.fieldName | ||
| * @param {Boolean} options.unique | ||
| * @param {Boolean} options.sparse | ||
| * @param {Function} cb Optional callback, signature: err | ||
| */ | ||
| ensureIndex(options:NeDB.EnsureIndexOptions, cb?:(err:Error)=>void):void; | ||
| /** | ||
| * Remove an index | ||
| * @param {String} fieldName | ||
| * @param {Function} cb Optional callback, signature: err | ||
| */ | ||
| removeIndex(fieldName:string, cb?:(err:Error)=>void):void; | ||
| /** | ||
| * Remove an index | ||
| * @param {String} fieldName | ||
| * @param {Function} cb Optional callback, signature: err | ||
| */ | ||
| removeIndex(fieldName:string, cb?:(err:Error)=>void):void; | ||
| /** | ||
| * Add one or several document(s) to all indexes | ||
| */ | ||
| addToIndexes<T>(doc:T):void; | ||
| addToIndexes<T>(doc:Array<T>):void; | ||
| /** | ||
| * Add one or several document(s) to all indexes | ||
| */ | ||
| addToIndexes<T>(doc:T):void; | ||
| addToIndexes<T>(doc:Array<T>):void; | ||
| /** | ||
| * Remove one or several document(s) from all indexes | ||
| */ | ||
| removeFromIndexes<T>(doc:T):void; | ||
| removeFromIndexes<T>(doc:Array<T>):void; | ||
| /** | ||
| * Remove one or several document(s) from all indexes | ||
| */ | ||
| removeFromIndexes<T>(doc:T):void; | ||
| removeFromIndexes<T>(doc:Array<T>):void; | ||
| /** | ||
| * Update one or several documents in all indexes | ||
| * To update multiple documents, oldDoc must be an array of { oldDoc, newDoc } pairs | ||
| * If one update violates a constraint, all changes are rolled back | ||
| */ | ||
| updateIndexes<T>(oldDoc:T, newDoc:T):void; | ||
| updateIndexes<T>(updates:Array<{oldDoc:T; newDoc:T;}>):void; | ||
| /** | ||
| * Update one or several documents in all indexes | ||
| * To update multiple documents, oldDoc must be an array of { oldDoc, newDoc } pairs | ||
| * If one update violates a constraint, all changes are rolled back | ||
| */ | ||
| updateIndexes<T>(oldDoc:T, newDoc:T):void; | ||
| updateIndexes<T>(updates:Array<{oldDoc:T; newDoc:T;}>):void; | ||
| /** | ||
| * Return the list of candidates for a given query | ||
| * Crude implementation for now, we return the candidates given by the first usable index if any | ||
| * We try the following query types, in this order: basic match, $in match, comparison match | ||
| * One way to make it better would be to enable the use of multiple indexes if the first usable index | ||
| * returns too much data. I may do it in the future. | ||
| * | ||
| * TODO: needs to be moved to the Cursor module | ||
| */ | ||
| getCandidates(query:any):void; | ||
| /** | ||
| * Return the list of candidates for a given query | ||
| * Crude implementation for now, we return the candidates given by the first usable index if any | ||
| * We try the following query types, in this order: basic match, $in match, comparison match | ||
| * One way to make it better would be to enable the use of multiple indexes if the first usable index | ||
| * returns too much data. I may do it in the future. | ||
| * | ||
| * TODO: needs to be moved to the Cursor module | ||
| */ | ||
| getCandidates(query:any):void; | ||
| /** | ||
| * Insert a new document | ||
| * @param {Function} cb Optional callback, signature: err, insertedDoc | ||
| */ | ||
| insert<T>(newDoc:T, cb?:(err:Error, document:T)=>void):void; | ||
| /** | ||
| * Insert a new document | ||
| * @param {Function} cb Optional callback, signature: err, insertedDoc | ||
| */ | ||
| insert<T>(newDoc:T, cb?:(err:Error, document:T)=>void):void; | ||
| /** | ||
| * Count all documents matching the query | ||
| * @param {any} query MongoDB-style query | ||
| */ | ||
| count(query:any, callback:(err:Error, n:number)=>void):void; | ||
| count(query:any):NeDB.CursorCount; | ||
| /** | ||
| * Count all documents matching the query | ||
| * @param {any} query MongoDB-style query | ||
| */ | ||
| count(query:any, callback:(err:Error, n:number)=>void):void; | ||
| count(query:any):NeDB.CursorCount; | ||
| /** | ||
| * Find all documents matching the query | ||
| * If no callback is passed, we return the cursor so that user can limit, skip and finally exec | ||
| * @param {any} query MongoDB-style query | ||
| * @param {any} projection MongoDB-style projection | ||
| */ | ||
| find<T>(query:any, projection:T, callback:(err:Error, documents:Array<T>)=>void):void; | ||
| find<T>(query:any, projection:T):NeDB.Cursor<T>; | ||
| /** | ||
| * Find all documents matching the query | ||
| * If no callback is passed, we return the cursor so that user can limit, skip and finally exec | ||
| * @param {any} query MongoDB-style query | ||
| * @param {any} projection MongoDB-style projection | ||
| */ | ||
| find<T>(query:any, projection:T, callback:(err:Error, documents:Array<T>)=>void):void; | ||
| find<T>(query:any, projection:T):NeDB.Cursor<T>; | ||
| /** | ||
| * Find all documents matching the query | ||
| * If no callback is passed, we return the cursor so that user can limit, skip and finally exec | ||
| * * @param {any} query MongoDB-style query | ||
| */ | ||
| find<T>(query:any, callback:(err:Error, documents:Array<T>)=>void):void; | ||
| find<T>(query:any):NeDB.Cursor<T>; | ||
| /** | ||
| * Find all documents matching the query | ||
| * If no callback is passed, we return the cursor so that user can limit, skip and finally exec | ||
| * * @param {any} query MongoDB-style query | ||
| */ | ||
| find<T>(query:any, callback:(err:Error, documents:Array<T>)=>void):void; | ||
| find<T>(query:any):NeDB.Cursor<T>; | ||
| /** | ||
| * Find one document matching the query | ||
| * @param {any} query MongoDB-style query | ||
| * @param {any} projection MongoDB-style projection | ||
| */ | ||
| findOne<T>(query:any, projection:T, callback:(err:Error, document:T)=>void):void; | ||
| /** | ||
| * Find one document matching the query | ||
| * @param {any} query MongoDB-style query | ||
| * @param {any} projection MongoDB-style projection | ||
| */ | ||
| findOne<T>(query:any, projection:T, callback:(err:Error, document:T)=>void):void; | ||
| /** | ||
| * Find one document matching the query | ||
| * @param {any} query MongoDB-style query | ||
| */ | ||
| findOne<T>(query:any, callback:(err:Error, document:T)=>void):void; | ||
| /** | ||
| * Find one document matching the query | ||
| * @param {any} query MongoDB-style query | ||
| */ | ||
| findOne<T>(query:any, callback:(err:Error, document:T)=>void):void; | ||
| /** | ||
| * Update all docs matching query | ||
| * For now, very naive implementation (recalculating the whole database) | ||
| * @param {any} query | ||
| * @param {any} updateQuery | ||
| * @param {Object} options Optional options | ||
| * options.multi If true, can update multiple documents (defaults to false) | ||
| * options.upsert If true, document is inserted if the query doesn't match anything | ||
| * @param {Function} cb Optional callback, signature: err, numReplaced, upsert (set to true if the update was in fact an upsert) | ||
| * | ||
| * @api private Use Datastore.update which has the same signature | ||
| */ | ||
| update(query:any, updateQuery:any, options?:NeDB.UpdateOptions, cb?:(err:Error, numberOfUpdated:number, upsert:boolean)=>void):void; | ||
| /** | ||
| * Update all docs matching query | ||
| * For now, very naive implementation (recalculating the whole database) | ||
| * @param {any} query | ||
| * @param {any} updateQuery | ||
| * @param {Object} options Optional options | ||
| * options.multi If true, can update multiple documents (defaults to false) | ||
| * options.upsert If true, document is inserted if the query doesn't match anything | ||
| * @param {Function} cb Optional callback, signature: err, numReplaced, upsert (set to true if the update was in fact an upsert) | ||
| * | ||
| * @api private Use Datastore.update which has the same signature | ||
| */ | ||
| update(query:any, updateQuery:any, options?:NeDB.UpdateOptions, cb?:(err:Error, numberOfUpdated:number, upsert:boolean)=>void):void; | ||
| /** | ||
| * Remove all docs matching the query | ||
| * For now very naive implementation (similar to update) | ||
| * @param {Object} query | ||
| * @param {Object} options Optional options | ||
| * options.multi If true, can update multiple documents (defaults to false) | ||
| * @param {Function} cb Optional callback, signature: err, numRemoved | ||
| * | ||
| * @api private Use Datastore.remove which has the same signature | ||
| */ | ||
| remove(query:any, options:NeDB.RemoveOptions, cb?:(err:Error, n:number)=>void):void; | ||
| remove(query:any, cb?:(err:Error, n:number)=>void):void; | ||
| } | ||
| /** | ||
| * Remove all docs matching the query | ||
| * For now very naive implementation (similar to update) | ||
| * @param {Object} query | ||
| * @param {Object} options Optional options | ||
| * options.multi If true, can update multiple documents (defaults to false) | ||
| * @param {Function} cb Optional callback, signature: err, numRemoved | ||
| * | ||
| * @api private Use Datastore.remove which has the same signature | ||
| */ | ||
| remove(query:any, options:NeDB.RemoveOptions, cb?:(err:Error, n:number)=>void):void; | ||
| remove(query:any, cb?:(err:Error, n:number)=>void):void; | ||
| } | ||
| export = NeDBDataStore; | ||
| export as namespace Nedb; | ||
| export = NeDBDataStore; | ||
| } | ||
| declare namespace NeDB { | ||
@@ -157,0 +155,0 @@ |
| { | ||
| "name": "@types/nedb", | ||
| "version": "0.0.21-alpha", | ||
| "version": "0.0.22-alpha", | ||
| "description": "TypeScript definitions for NeDB", | ||
@@ -8,2 +8,6 @@ "main": "", | ||
| "author": "Stefan Steinhart <https://github.com/reppners>", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git" | ||
| }, | ||
| "license": "MIT", | ||
@@ -10,0 +14,0 @@ "typings": "index.d.ts", |
@@ -11,9 +11,9 @@ # Installation | ||
| Additional Details | ||
| * Last updated: Wed, 25 May 2016 04:20:26 GMT | ||
| * File structure: OldUMD | ||
| * Last updated: Fri, 01 Jul 2016 18:42:29 GMT | ||
| * File structure: UMD | ||
| * Library Dependencies: none | ||
| * Module Dependencies: none | ||
| * Global values: none | ||
| * Global values: NeDBDataStore, Nedb | ||
| # Credits | ||
| These definitions were written by Stefan Steinhart <https://github.com/reppners>. |
@@ -13,11 +13,12 @@ { | ||
| "sourceBranch": "types-2.0", | ||
| "kind": "OldUMD", | ||
| "globals": [], | ||
| "declaredModules": [ | ||
| "nedb" | ||
| "kind": "UMD", | ||
| "globals": [ | ||
| "NeDBDataStore", | ||
| "Nedb" | ||
| ], | ||
| "declaredModules": [], | ||
| "files": [ | ||
| "index.d.ts" | ||
| ], | ||
| "contentHash": "8756ed6bdc9a5aa93cf7c6343c4416a4e1689ae1a8688a83416ed90790685704" | ||
| "contentHash": "70ecc9a322209e43eb110d5c873a1c64a2493e5e95ac395408b7d44f7e85ee88" | ||
| } |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Improved metrics
- Number of low supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-4.9%
10406
No dependency changes