docs(type): add types for UpsGlobalSubscriptionModel

Chinlinlee · Jan 25, 2024 · 48d047d · 48d047d
1 parent bef1153
commit 48d047d
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 3 deletions.
diff --git a/models/mongodb/models/upsGlobalSubscription.js b/models/mongodb/models/upsGlobalSubscription.js
@@ -33,29 +33,42 @@ let upsGlobalSubscriptionSchema = new mongoose.Schema(
             getters: true
         },
         statics: {
+            /**
+             * @type {import("@root/utils/typeDef/models/upsGlobalSubscription").UpsGlobalSubscriptionConstructor["getCursor"]}
+             */
             getCursor: async function (query, options) {
                 return await mongoose.model("upsGlobalSubscription").find(query, options).cursor();
             },
+            /**
+             * @type { import("@root/utils/typeDef/models/upsGlobalSubscription").UpsGlobalSubscriptionConstructor["createGlobalSubscription"] }
+             */
             createGlobalSubscription: async function (globalSubscription) {
                 return await mongoose.model("upsGlobalSubscription").create(globalSubscription);
             },
+            /**
+             * @type { import("@root/utils/typeDef/models/upsGlobalSubscription").UpsGlobalSubscriptionConstructor["updateRepositoryInstance"] } 
+             */
             updateRepositoryInstance: async function (globalSubscription, query, deletionLock, subscribed) {
                 globalSubscription.isDeletionLock = deletionLock;
                 globalSubscription.subscribed = subscribed;
                 globalSubscription.queryKeys = query;
                 return await globalSubscription.save();
             },
+            /**
+             * @type { import("@root/utils/typeDef/models/upsGlobalSubscription").UpsGlobalSubscriptionConstructor["findOneByAeTitle"] } 
+             */
             findOneByAeTitle: async function (aeTitle) {
                 return await mongoose.model("upsGlobalSubscription").findOne({ aeTitle: aeTitle });
             },
             /**
-             * 
-             * @param {string} aeTitle 
-             * @returns 
+             * @type { import("@root/utils/typeDef/models/upsGlobalSubscription").UpsGlobalSubscriptionConstructor["getCountByAeTitle"] }
              */
             getCountByAeTitle: async function (aeTitle) {
                 return await mongoose.model("upsGlobalSubscription").countDocuments({ aeTitle: aeTitle });
             },
+            /**
+             * @type { import("@root/utils/typeDef/models/upsGlobalSubscription").UpsGlobalSubscriptionConstructor["deleteOneByAeTitle"] }
+             */
             deleteOneByAeTitle: async function (aeTitle) {
                 return await mongoose.model("upsGlobalSubscription").findOneAndDelete({ aeTitle: aeTitle });
             }
@@ -71,4 +84,5 @@ let upsSubscriptionModel = mongoose.model(
 );
 
 module.exports = upsSubscriptionModel;
+/** @type { import("@root/utils/typeDef/models/upsGlobalSubscription").UpsGlobalSubscriptionConstructor } */
 module.exports.UpsGlobalSubscriptionModel = upsSubscriptionModel;
diff --git a/utils/typeDef/models/upsGlobalSubscription.d.ts b/utils/typeDef/models/upsGlobalSubscription.d.ts
@@ -0,0 +1,30 @@
+export interface UpsGlobalSubscriptionConstructor {
+    new(): UpsGlobalSubscriptionModel;
+    /**
+     * 
+     * @param query 
+     * @param options 
+     * @returns Cursor
+     */
+    public static getCursor(query: any, options: any): Promise<any>;
+    public static createGlobalSubscription(
+        globalSubscription: UpsGlobalSubscription
+    ): Promise<UpsGlobalSubscriptionModel>;
+    public static updateRepositoryInstance(
+        globalSubscription: UpsGlobalSubscriptionModel
+    ): Promise<UpsGlobalSubscriptionModel>;
+    public static findOneByAeTitle(
+        aeTitle: string
+    ): Promise<UpsGlobalSubscriptionModel>;
+    public static getCountByAeTitle(aeTitle: string): Promise<number>;
+    public static deleteOneByAeTitle(aeTitle: string): Promise<void>;
+}
+
+export type UpsGlobalSubscription = {
+    aeTitle: string;
+    subscribed: number;
+    queryKeys: any;
+    isDeletionLock: boolean;
+};
+
+export interface UpsGlobalSubscriptionModel {}