include docs

dist/destroy.d.ts

@@ -1,14 +1,17 @@
-import * as mongoose from "mongoose";
+import { Document, Model } from 'mongoose';
 /**
- * Delete a Resource
+ * Deletes the first documents that matches where from the collection.
+ * it returns the document that has been deleted.
+
+ *
+ * @param obj.model  Mongoose Model reference
+ * @param obj.where  MongoDB filter object
+ *
+ * @since 0.2.1
  * @author KingRayhan <me@rayhan.info>
- * @param {object} obj
- * @param {MongooseModel} obj.model - mongoose Model reference
- * @param {import("mongoose").FilterQuery} obj.where - MongoDB filter object
- * @param {object} data - data object for delete
  */
-declare const destroy: ({ model, where, }: {
-    model: mongoose.Model<any, {}>;
-    where: mongoose.MongooseFilterQuery<Pick<any, string | number | symbol>>;
-}) => Promise<any>;
+declare const destroy: (obj: {
+    model: Model<any, {}>;
+    where: import("mongoose").MongooseFilterQuery<Pick<any, string | number | symbol>>;
+}) => Promise<Document>;
 export default destroy;

dist/destroyAll.d.ts

@@ -1,15 +1,17 @@
-import * as mongoose from 'mongoose';
+import { Model } from 'mongoose';
 /**
- * Delete all documents that matches where keys
- * @author KingRayhan <me@rayhan.info>
+ * Deletes all documents that matches `where` from the collection.
+ * @param {object} obj Quick Crud options
+ * @param obj.model  Mongoose Model reference
+ * @param obj.where  MongoDB filter object
  *
- * @param {MongooseModel} Model - mongoose Model reference
- * @param {import("mongoose").FilterQuery} where - MongoDB filter object
+ * @since 0.2.1
+ * @author KingRayhan <me@rayhan.info>
  */
 declare const destroyAll: ({ model, where }: {
-    model: mongoose.Model<any, {}>;
-    where: mongoose.MongooseFilterQuery<Pick<any, string | number | symbol>>;
-}) => mongoose.Query<{
+    model: Model<any, {}>;
+    where: import("mongoose").MongooseFilterQuery<Pick<any, string | number | symbol>>;
+}) => import("mongoose").Query<{
     ok?: number | undefined;
     n?: number | undefined;
 } & {

dist/index.d.ts

@@ -1,26 +1,15 @@
-import * as mongoose from "mongoose";
-import { PaginationOptions } from "./utils/interfaces";
-/**
- * @typedef {import("mongoose").Model} MongooseModel
- */
-/**
- * Quick crud resource PaginationOptions
- * @typedef {object} PaginationOptions
- * @property {number} [page] - Pagination page number. Default is 1.
- * @property {number} [limit] - Resource count to show. Default is 10
- * @property {string} [sort] - MongoDB property sort key. Default is -createdAt
- */
+import * as mongoose from 'mongoose';
+import { PaginationOptions } from './utils/interfaces';
 /**
  * Fetching all Resources
- * @param {MongooseModel} Model - Mongoose Model reference
- * @param {object} where - Mongoose filter object
- * @param {PaginationOptions} paginationOptions - Resource PaginationOptions
- * @param {string} populateOptions - Population schema properties seperated by space
- * @return {object} - return resources
+ * @param options.Model - Mongoose Model reference
+ * @param options.where - Mongoose filter object
+ * @param options.paginationOptions - Resource PaginationOptions
+ * @param populateOptions - Mongoose population object/string
  *
  * @author KingRayhan <me@rayhan.info>
  */
-declare const index: ({ model, where, paginationOptions, populateOptions, }: {
+declare const index: ({ model, where, paginationOptions, populateOptions }: {
     model: mongoose.Model<any, {}>;
     where?: mongoose.MongooseFilterQuery<any> | undefined;
     paginationOptions?: PaginationOptions | undefined;

dist/show.d.ts

@@ -1,17 +1,17 @@
-import * as mongoose from "mongoose";
+import { Model, QueryPopulateOptions } from 'mongoose';
 /**
  * Fetching single Resource
- * @param {object} obj
- * @param {MongooseModel} model - mongoose Model reference
- * @param {import("mongoose").QueryPopulateOptions} populateOptions - Population schema properties seperated by space
- * @param {import("mongoose").FilterQuery} where - MongoDB filter object
- * @return {import("mongoose").Query} - return a single resource
  *
+ * @param obj.model - Mongoose Model reference
+ * @param obj.populateOptions - Mongoose population object/string
+ * @param obj.where - MongoDB filter object
+ *
+ * @since 0.2.1
  * @author KingRayhan <me@rayhan.info>
  */
-declare const show: ({ model, where, populateOptions, }: {
-    model: mongoose.Model<any, {}>;
-    where: mongoose.MongooseFilterQuery<Pick<any, string | number | symbol>>;
-    populateOptions?: mongoose.QueryPopulateOptions | undefined;
-}) => mongoose.DocumentQuery<any, any, {}>;
+declare const show: ({ model, where, populateOptions }: {
+    model: Model<any, {}>;
+    where: import("mongoose").MongooseFilterQuery<Pick<any, string | number | symbol>>;
+    populateOptions?: QueryPopulateOptions | undefined;
+}) => import("mongoose").DocumentQuery<any, any, {}>;
 export default show;

dist/store.d.ts

@@ -1,17 +1,15 @@
-import * as mongoose from "mongoose";
-/**
- * @typedef {import("mongoose").Model} MongooseModel
- */
+import { Model } from 'mongoose';
 /**
  * Create a document
- * @param {object} obj
- * @param {MongooseModel} obj.model - mongoose Model reference
- * @param {object} obj.data - An object of data to store in MongoDB based on Mongoose Schema
+`*
+ * @param obj.model - Mongoose Model reference
+ * @param obj.data - An object of data to store in MongoDB based on Mongoose Schema`
  *
+ * @since 0.2.1
  * @author KingRayhan <me@rayhan.info>
  */
-declare const store: ({ model, data }: {
-    model: mongoose.Model<any, {}>;
+declare const store: (options: {
+    model: Model<any, {}>;
     data: any;
 }) => Promise<any>;
 export default store;

dist/update.d.ts

@@ -1,12 +1,16 @@
-import * as mongoose from "mongoose";
+import * as mongoose from 'mongoose';
 /**
- * Update a Resource
- * @param {MongooseModel} Model - mongoose Model reference
- * @param {import("mongoose").FilterQuery} where - MongoDB filter object
- * @param {object} data - An object of data to update in MongoDB based on Mongoose Schema
+ * Updates the first document that matches where
+ * `data` is the object where you want to update the data.
+ *
+ * @param obj.model - Mongoose Model reference
+ * @param obj.where - MongoDB filter object
+ * @param obj.data - An object of data to update that matches with where filter key(s)
+ *
+ * @since 0.2.1
  * @author KingRayhan <me@rayhan.info>
  */
-declare const update: ({ model, where, data, }: {
+declare const update: ({ model, where, data }: {
     model: mongoose.Model<any, {}>;
     where: mongoose.MongooseFilterQuery<Pick<any, string | number | symbol>>;
     data: any;