@khanacademy/wonder-blocks-timing 4.0.1 → 5.0.0

package/dist/util/interval.d.ts

@@ -1,4 +1,5 @@
-import type { IInterval, SchedulePolicy, ClearPolicy } from "./types";
+import { SchedulePolicy, ClearPolicy } from "./policies";
+import type { IInterval } from "./types";
 /**
  * Encapsulates everything associated with calling setInterval/clearInterval,
  * and managing the lifecycle of that interval. This includes the ability to
@@ -9,17 +10,17 @@ import type { IInterval, SchedulePolicy, ClearPolicy } from "./types";
  * @implements {IInterval}
  */
 export default class Interval implements IInterval {
-    _intervalId: number | null | undefined;
+    _intervalId: ReturnType<typeof setInterval> | null | undefined;
     _action: () => unknown;
     _intervalMs: number;
     /**
      * Creates an interval that will invoke the given action after
      * the given period. The interval does not start until set is called.
      *
-     * @param {() => mixed} action The action to be invoked each time the
+     * @param action The action to be invoked each time the
      * interval period has passed.
-     * @param {number} intervalMs The interval period.
-     * @param {SchedulePolicy} [schedulePolicy] When SchedulePolicy.Immediately,
+     * @param intervalMs The interval period.
+     * @param [schedulePolicy] When SchedulePolicy.Immediately,
      * the interval is set immediately on instantiation; otherwise, `set` must be
      * called to set the interval.
      * Defaults to `SchedulePolicy.Immediately`.
@@ -29,7 +30,7 @@ export default class Interval implements IInterval {
     /**
      * Determine if the interval is active or not.
      *
-     * @returns {boolean} true if the interval is active, otherwise false.
+     * @returns true if the interval is active, otherwise false.
      * @memberof Interval
      */
     get isSet(): boolean;
@@ -48,12 +49,11 @@ export default class Interval implements IInterval {
      * If the interval is active, this cancels that interval. If no interval is
      * pending, this does nothing.
      *
-     * @param {ClearPolicy} [policy] When ClearPolicy.Resolve, if the request
+     * @param [policy] When ClearPolicy.Resolve, if the request
      * was set when called, the request action is invoked after cancelling
      * the request; otherwise, the pending action is cancelled.
      * Defaults to `ClearPolicy.Cancel`.
      *
-     * @returns {void}
      * @memberof Interval
      */
     clear(policy?: ClearPolicy): void;

package/dist/util/policies.d.ts

@@ -1,8 +1,12 @@
-export declare const SchedulePolicy: {
-    readonly Immediately: "schedule-immediately";
-    readonly OnDemand: "schedule-on-demand";
-};
-export declare const ClearPolicy: {
-    readonly Resolve: "resolve-on-clear";
-    readonly Cancel: "cancel-on-clear";
-};
+export declare enum SchedulePolicy {
+    Immediately = "schedule-immediately",
+    OnDemand = "schedule-on-demand"
+}
+export declare enum ClearPolicy {
+    Resolve = "resolve-on-clear",
+    Cancel = "cancel-on-clear"
+}
+export declare enum ActionPolicy {
+    Reset = "reset",
+    Passive = "passive"
+}

package/dist/util/timeout.d.ts

@@ -1,4 +1,5 @@
-import type { ITimeout, SchedulePolicy, ClearPolicy } from "./types";
+import { SchedulePolicy, ClearPolicy } from "./policies";
+import type { ITimeout } from "./types";
 /**
  * Encapsulates everything associated with calling setTimeout/clearTimeout, and
  * managing the lifecycle of that timer, including the ability to resolve or
@@ -9,17 +10,17 @@ import type { ITimeout, SchedulePolicy, ClearPolicy } from "./types";
  * @implements {ITimeout}
  */
 export default class Timeout implements ITimeout {
-    _timeoutId: number | null | undefined;
+    _timeoutId: ReturnType<typeof setTimeout> | null | undefined;
     _action: () => unknown;
     _timeoutMs: number;
     /**
      * Creates a timeout that will invoke the given action after
      * the given period. The timeout does not start until set is called.
      *
-     * @param {() => mixed} action The action to be invoked when the timeout
+     * @param action The action to be invoked when the timeout
      * period has passed.
-     * @param {number} timeoutMs The timeout period.
-     * @param {SchedulePolicy} [schedulePolicy] When SchedulePolicy.Immediately,
+     * @param timeoutMs The timeout period.
+     * @param [schedulePolicy] When SchedulePolicy.Immediately,
      * the timer is set immediately on instantiation; otherwise, `set` must be
      * called to set the timeout.
      * Defaults to `SchedulePolicy.Immediately`.
@@ -29,7 +30,7 @@ export default class Timeout implements ITimeout {
     /**
      * Determine if the timeout is set or not.
      *
-     * @returns {boolean} true if the timeout is set (aka pending), otherwise
+     * @returns true if the timeout is set (aka pending), otherwise
      * false.
      * @memberof Timeout
      */
@@ -50,7 +51,7 @@ export default class Timeout implements ITimeout {
      * If the timeout is pending, this cancels that pending timeout without
      * invoking the action. If no timeout is pending, this does nothing.
      *
-     * @param {ClearPolicy} [policy] When ClearPolicy.Resolve, if the request
+     * @param [policy] When ClearPolicy.Resolve, if the request
      * was set when called, the request action is invoked after cancelling
      * the request; otherwise, the pending action is cancelled.
      * Defaults to `ClearPolicy.Cancel`.

package/dist/util/types.d.ts

@@ -1,5 +1,4 @@
-export type SchedulePolicy = "schedule-immediately" | "schedule-on-demand";
-export type ClearPolicy = "resolve-on-clear" | "cancel-on-clear";
+import * as Policies from "./policies";
 /**
  * Encapsulates everything associated with calling setTimeout/clearTimeout, and
  * managing the lifecycle of that timer, including the ability to resolve or
@@ -33,14 +32,14 @@ export interface ITimeout {
      * If the timeout is pending, this cancels that pending timeout. If no
      * timeout is pending, this does nothing.
      *
-     * @param {ClearPolicy} [policy] When ClearPolicy.Resolve, if the request
+     * @param [policy] When ClearPolicy.Resolve, if the request
      * was set when called, the request action is invoked after cancelling
      * the request; otherwise, the pending action is cancelled.
      * Defaults to `ClearPolicy.Cancel`.
      *
      * @memberof ITimeout
      */
-    clear(policy?: ClearPolicy): void;
+    clear(policy?: Policies.ClearPolicy): void;
 }
 /**
  * Encapsulates everything associated with calling setInterval/clearInterval,
@@ -73,14 +72,14 @@ export interface IInterval {
      * If the interval is active, this cancels that interval. If the interval
      * is not active, this does nothing.
      *
-     * @param {ClearPolicy} [policy] When ClearPolicy.Resolve, if the request
+     * @param [policy] When ClearPolicy.Resolve, if the request
      * was set when called, the request action is invoked after cancelling
      * the request; otherwise, the pending action is cancelled.
      * Defaults to `ClearPolicy.Cancel`.
      *
      * @memberof IInterval
      */
-    clear(policy?: ClearPolicy): void;
+    clear(policy?: Policies.ClearPolicy): void;
 }
 /**
  * Encapsulates everything associated with calling requestAnimationFrame/
@@ -115,18 +114,27 @@ export interface IAnimationFrame {
      * If the request is pending, this cancels that pending request. If no
      * request is pending, this does nothing.
      *
-     * @param {ClearPolicy} [policy] When ClearPolicy.Resolve, if the request
+     * @param [policy] When ClearPolicy.Resolve, if the request
      * was set when called, the request action is invoked after cancelling
      * the request; otherwise, the pending action is cancelled.
      * Defaults to `ClearPolicy.Cancel`.
      *
      * @memberof IAnimationFrame
      */
-    clear(policy?: ClearPolicy): void;
+    clear(policy?: Policies.ClearPolicy): void;
 }
+/**
+ * Options for the scheduling APIs.
+ */
 export type Options = {
-    schedulePolicy?: SchedulePolicy;
-    clearPolicy?: ClearPolicy;
+    schedulePolicy?: Policies.SchedulePolicy;
+    clearPolicy?: Policies.ClearPolicy;
+};
+/**
+ * Options for the hook variants of our scheduling APIs.
+ */
+export type HookOptions = Options & {
+    actionPolicy?: Policies.ActionPolicy;
 };
 /**
  * Provides means to request timeouts, intervals, and animation frames, with

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@khanacademy/wonder-blocks-timing",
   "private": false,
-  "version": "4.0.1",
+  "version": "5.0.0",
   "design": "v1",
   "publishConfig": {
     "access": "public"
@@ -17,8 +17,8 @@
     "react": "16.14.0"
   },
   "devDependencies": {
-    "wb-dev-build-settings": "^0.9.7"
+    "@khanacademy/wb-dev-build-settings": "^1.0.0"
   },
   "author": "",
   "license": "MIT"
-}
+}

package/src/components/with-action-scheduler.tsx

@@ -18,11 +18,19 @@ type WithoutActionScheduler<T> = Omit<T, "schedule">;
 export default function withActionScheduler<
     Props extends WithActionSchedulerProps,
 >(WrappedComponent: React.ComponentType<Props>) {
-    return (props: WithoutActionScheduler<Props>) => (
+    const displayName = `withActionScheduler(${
+        WrappedComponent.displayName || WrappedComponent.name
+    })`;
+
+    const C = (props: WithoutActionScheduler<Props>) => (
         <ActionSchedulerProvider>
             {(schedule: IScheduleActions) => (
                 <WrappedComponent {...(props as Props)} schedule={schedule} />
             )}
         </ActionSchedulerProvider>
     );
+
+    C.displayName = displayName;
+
+    return C;
 }