🤖 Merge PR DefinitelyTyped#74424 DEV: Add deferrable function definitions to Meteor typings by @Grubba27

Author: Grubba27

types/meteor/meteor.d.ts

@@ -235,6 +235,31 @@ declare module 'meteor/meteor' {
          * @param func The function to run
          */
         function defer(func: Function): void;
+
+        /**
+         * Wrap a function so that it only runs in background in specified environments..
+         * @param func The function to wrap
+         * @param options An object with an `on` property that is an array of environment names: `"development"`, `"production"`, and/or `"test"`.
+         */
+        function deferrable<T>(
+            func: () => T,
+            options: { on: Array<"development" | "production" | "test"> }
+        ): T | void;
+
+        /**
+         * Wrap a function to run in the background in development (similar to Meteor.isDevelopment ? Meteor.defer(fn) : Meteor.startup(fn)).
+         * @param func The function to wrap
+         */
+        function deferDev<T>(
+            func: () => T
+        ): T | void;
+        /**
+         * Wrap a function to run in the background in production (similar to Meteor.isProduction ? Meteor.defer(fn) : Meteor.startup(fn)).
+         * @param func The function to wrap
+         */
+        function deferProd<T>(
+            func: () => T
+        ): T | void;
         /** Timeout **/
 
         /** utils **/

types/meteor/test/meteor-tests.ts

@@ -88,6 +88,12 @@ namespace MeteorTests {
                 .aggregate([{ $group: { _id: null, names: { $addToSet: '$name' } } }])
                 .toArray()
                 .then();
+
+            Meteor.deferrable(
+                () => console.log('This is deferred until after startup.'),
+                {on: ['development', 'test']},
+            )
+
         });
     }
 
@@ -398,6 +404,7 @@ namespace MeteorTests {
         if (Meteor.isServer) {
             Logs.remove({});
             Players.remove({ karma: { $lt: -2 } });
+            Meteor.defer(() => console.log('Old low-karma players removed from the Players collection.'));
         }
     });
 
@@ -1203,6 +1210,14 @@ namespace MeteorTests {
         Rooms._dropIndex('indexName');
     }
 
+    Meteor.deferDev(() => {
+        console.log('This is a development-only deferred function.');
+    });
+
+    Meteor.deferProd(() => {
+        console.log('This is a production-only deferred function.');
+    });
+
     (async function() {
         await Rooms.dropIndexAsync('indexName');
     })();