codehooks-js 1.3.23 → 1.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codehooks-js",
-  "version": "1.3.23",
+  "version": "1.3.24",
   "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,7 +312,7 @@ 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
    */
   getOne: (collection: string, query: string | object) => Promise<any>;
   /**
@@ -315,9 +321,13 @@ export type DatastoreAPI = {
    */
   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)
    */
   findOne: (collection: string, query: string | object) => Promise<any>;
+  /**
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object or null if not found
+   */
+  findOneOrNull: (collection: string, query: string | object) => Promise<any>;
   /**
    * - Alias for getMany
    * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options