codehooks-js 1.3.23 → 1.3.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codehooks-js",
-  "version": "1.3.23",
+  "version": "1.3.25",
   "type": "module",
   "description": "Codehooks.io official library - provides express.JS like syntax",
   "main": "index.js",

package/types/index.d.ts

@@ -198,13 +198,19 @@ export type keyvalOptions = {
  */
 export type NoSQLAPI = {
   /**
-   * - Get object by ID, returns a Promise with the object
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object
+   * @throws {Error} Rejects if the object is not found
    */
   getOne: (query: string | object) => Promise<object>;
   /**
-   * - Get object by ID, returns a Promise with the object - alias for getOne
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object - alias for getOne
+   * @throws {Error} Rejects if the object is not found
    */
   findOne: (query: string | object) => Promise<object>;
+  /**
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object or null if not found
+   */
+  findOneOrNull: (query: string | object) => Promise<object | null>;
   /**
    * - Get stream of objects by query
    * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
@@ -306,18 +312,24 @@ export type DatastoreAPI = {
    */
   collection: (collection: string) => NoSQLAPI;
   /**
-   * - Get object by ID, returns a Promise with the object
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object
+   * @throws {Error} Rejects if the object is not found
    */
-  getOne: (collection: string, query: string | object) => Promise<any>;
+  getOne: (collection: string, query: string | object) => Promise<object>;
   /**
    * - Get stream of objects by query
    * * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
    */
   getMany: (collection: string, query?: object, options?: object) => DataStream;
   /**
-   * - Get object by ID, returns a Promise with the object (alias for getOne)
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object (alias for getOne)
+   * @throws {Error} Rejects if the object is not found
+   */
+  findOne: (collection: string, query: string | object) => Promise<object>;
+  /**
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object or null if not found
    */
-  findOne: (collection: string, query: string | object) => Promise<any>;
+  findOneOrNull: (collection: string, query: string | object) => Promise<object | null>;
   /**
    * - Alias for getMany
    * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
@@ -334,14 +346,14 @@ export type DatastoreAPI = {
    * @param query string | object
    * @param updateoperators object
    * @param options object - {upsert: true}
-   * @returns Promise<any>
+   * @returns Promise<object>
    */
   updateOne: (
     collection: string,
     query: string | object,
     updateoperators?: object,
     options?: object
-  ) => Promise<any>;
+  ) => Promise<object>;
   /**
    * - Update multiple data objects in a datastore collection.
    * - Input document is patched with the matched database objects
@@ -351,7 +363,7 @@ export type DatastoreAPI = {
     query: object,
     document: object,
     updateoperators?: object
-  ) => Promise<any>;
+  ) => Promise<object>;
   /**
    * - Replace one data object by ID in a datastore collection.
    * - Input document overwrites the matched database object, the _id value is not overwritten.
@@ -359,8 +371,9 @@ export type DatastoreAPI = {
   replaceOne: (
     collection: string,
     query: string | object,
+    document: object,
     options?: object
-  ) => Promise<any>;
+  ) => Promise<object>;
   /**
    * - Replace multiple data objects in a datastore collection.
    * - Input document overwrites the matched database objects. The _id value is not overwritten
@@ -368,16 +381,17 @@ export type DatastoreAPI = {
   replaceMany: (
     collection: string,
     query: object,
+    document: object,
     options?: object
-  ) => Promise<any>;
+  ) => Promise<object>;
   /**
    * - Remove one data object by ID in a collection in the current Datastore
    */
-  removeOne: (collection: string, query: string | object) => Promise<any>;
+  removeOne: (collection: string, query: string | object) => Promise<object>;
   /**
    * - Remove multiple data objects in a collection in the current Datastore
    */
-  removeMany: (collection: string, query: object) => Promise<any>;
+  removeMany: (collection: string, query: object) => Promise<object>;
   /**
    * - Set a key-value pair in the current Datastore
    */