@khanacademy/wonder-blocks-timing 4.0.1 → 5.0.0

package/dist/util/interval.js.flow

@@ -1,69 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { IInterval, SchedulePolicy, ClearPolicy } from "./types";
-
-/**
- * Encapsulates everything associated with calling setInterval/clearInterval,
- * and managing the lifecycle of that interval. This includes the ability to
- * cancel the interval, and knowing if the interval is active.
- * @export
- * @class Interval
- * @implements
- */
-declare export default class Interval implements IInterval {
-  _intervalId: number | null | void;
-  _action: () => mixed;
-  _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
-   * interval period has passed.
-   * @param {number} intervalMs The interval period.
-   * @param {SchedulePolicy} [schedulePolicy] When SchedulePolicy.Immediately,
-   * the interval is set immediately on instantiation; otherwise, `set` must be
-   * called to set the interval.
-   * Defaults to `SchedulePolicy.Immediately`.
-   * @memberof Interval
-   */
-  constructor(
-    action: () => mixed,
-    intervalMs: number,
-    schedulePolicy?: SchedulePolicy
-  ): this;
-
-  /**
-   * Determine if the interval is active or not.
-   * @returns {boolean} true if the interval is active, otherwise false.
-   * @memberof Interval
-   */
-  isSet: boolean;
-
-  /**
-   * Activate the interval.
-   *
-   * If the interval is active, this cancels that interval and starts the
-   * interval afresh. If the interval is not active, this starts it.
-   * @memberof Interval
-   */
-  set(): void;
-
-  /**
-   * Clear the active interval.
-   *
-   * 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
-   * 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.js.flow

@@ -1,14 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-declare export var SchedulePolicy: {|
-  +Immediately: "schedule-immediately",
-  +OnDemand: "schedule-on-demand",
-|};
-declare export var ClearPolicy: {|
-  +Resolve: "resolve-on-clear",
-  +Cancel: "cancel-on-clear",
-|};

package/dist/util/timeout.js.flow

@@ -1,71 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-import type { ITimeout, SchedulePolicy, ClearPolicy } from "./types";
-
-/**
- * Encapsulates everything associated with calling setTimeout/clearTimeout, and
- * managing the lifecycle of that timer, including the ability to resolve or
- * cancel a pending timeout action.
- * @export
- * @class Timeout
- * @implements
- */
-declare export default class Timeout implements ITimeout {
-  _timeoutId: number | null | void;
-  _action: () => mixed;
-  _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
-   * period has passed.
-   * @param {number} timeoutMs The timeout period.
-   * @param {SchedulePolicy} [schedulePolicy] When SchedulePolicy.Immediately,
-   * the timer is set immediately on instantiation; otherwise, `set` must be
-   * called to set the timeout.
-   * Defaults to `SchedulePolicy.Immediately`.
-   * @memberof Timeout
-   */
-  constructor(
-    action: () => mixed,
-    timeoutMs: number,
-    schedulePolicy?: SchedulePolicy
-  ): this;
-
-  /**
-   * Determine if the timeout is set or not.
-   * @returns {boolean} true if the timeout is set (aka pending), otherwise
-   * false.
-   * @memberof Timeout
-   */
-  isSet: boolean;
-
-  /**
-   * Set the timeout.
-   *
-   * If the timeout is pending, this cancels that pending timeout and
-   * sets the timeout afresh. If the timeout is not pending, this
-   * sets a new timeout.
-   * @memberof Timeout
-   */
-  set(): void;
-
-  /**
-   * Clear the set timeout.
-   *
-   * 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
-   * 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 Timeout
-   */
-  clear(policy?: ClearPolicy): void;
-}

package/dist/util/types.js.flow

@@ -1,232 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */
-export type SchedulePolicy = "schedule-immediately" | "schedule-on-demand";
-export type ClearPolicy = "resolve-on-clear" | "cancel-on-clear";
-/**
- * Encapsulates everything associated with calling setTimeout/clearTimeout, and
- * managing the lifecycle of that timer, including the ability to resolve or
- * cancel a pending timeout action.
- * @export
- * @interface ITimeout
- */
-export interface ITimeout {
-  /**
-   * Determine if the timeout is set or not.
-   * @returns {boolean} true if the timeout is set (aka pending), otherwise
-   * false.
-   * @memberof ITimeout
-   */
-  isSet: boolean;
-
-  /**
-   * Set the timeout.
-   *
-   * If the timeout is pending, this cancels that pending timeout and
-   * starts the timeout afresh. If the timeout is not pending, this
-   * starts the timeout.
-   * @memberof ITimeout
-   */
-  set(): void;
-
-  /**
-   * Clear the set timeout.
-   *
-   * 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
-   * 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;
-}
-/**
- * Encapsulates everything associated with calling setInterval/clearInterval,
- * and managing the lifecycle of that interval, including the ability to resolve
- * or cancel an active interval.
- * @export
- * @interface IInterval
- */
-export interface IInterval {
-  /**
-   * Determine if the interval is active or not.
-   * @returns {boolean} true if the interval is active, otherwise false.
-   * @memberof IInterval
-   */
-  isSet: boolean;
-
-  /**
-   * Set the interval.
-   *
-   * If the interval is active, this cancels that interval and restarts it
-   * afresh. If the interval is not active, this starts the interval.
-   * @memberof IInterval
-   */
-  set(): void;
-
-  /**
-   * Clear the active interval.
-   *
-   * 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
-   * 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;
-}
-/**
- * Encapsulates everything associated with calling requestAnimationFrame/
- * cancelAnimationFrame, and managing the lifecycle of that request, including
- * the ability to resolve or cancel a pending request.
- * @export
- * @interface IAnimationFrame
- */
-export interface IAnimationFrame {
-  /**
-   * Determine if the request is set or not.
-   * @returns {boolean} true if the request is set (aka pending), otherwise
-   * false.
-   * @memberof IAnimationFrame
-   */
-  isSet: boolean;
-
-  /**
-   * Set the request.
-   *
-   * If the request is pending, this cancels that pending request and
-   * starts a request afresh. If the request is not pending, this
-   * starts the request.
-   * @memberof IAnimationFrame
-   */
-  set(): void;
-
-  /**
-   * Clear the set request.
-   *
-   * 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
-   * 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;
-}
-export type Options = {|
-  schedulePolicy?: SchedulePolicy,
-  clearPolicy?: ClearPolicy,
-|};
-/**
- * Provides means to request timeouts, intervals, and animation frames, with
- * additional support for clearing all requested actions.
- *
- * This interface describes a replacement for the `setTimeout`/`clearTimeout`,
- * `setInterval`/`clearInterval` and `requestAnimationFrame`/`cancelAnimationFrame`
- * APIs that supports the ability to easily clear all pending actions.
- * @export
- * @interface IScheduleActions
- */
-export interface IScheduleActions {
-  /**
-   * Request a timeout.
-   *
-   * A timeout will wait for a given period and then invoke a given action.
-   * @param {() => void} action The action to be invoked when the timeout
-   * period is reached.
-   * @param {number} period The timeout period in milliseconds. The action
-   * will be invoked after this period has passed since the timeout was set.
-   * This value must be greater than or equal to zero.
-   * @param {boolean} [autoSchedule] Whether or not to set the timeout as soon
-   * as this call is made, or wait until `set` is explicitly called. Defaults
-   * to `true`.
-   * @param {boolean} [resolveOnClear] Whether or not the associated action
-   * will be invoked if it is still pending at the point the timeout is
-   * cleared. Defaults to `false`.
-   * @returns {ITimeout} A interface for manipulating the created timeout.
-   * @memberof IScheduleActions
-   */
-  timeout(action: () => mixed, period: number, options?: Options): ITimeout;
-
-  /**
-   * Request an interval.
-   *
-   * An interval will invoke a given action each time the given period has
-   * passed until the interval is cleared.
-   * @param {() => void} action The action to be invoked when the interval
-   * period occurs.
-   * @param {number} period The interval period in milliseconds. The action
-   * will be invoked each time this period has passed since the interval was
-   * set or last occurred.
-   * This value must be greater than zero.
-   * @param {boolean} [autoSchedule] Whether or not to set the interval as soon
-   * as this call is made, or wait until `set` is explicitly called. Defaults
-   * to `true`.
-   * @param {boolean} [resolveOnClear] Whether or not the associated action
-   * will be invoked at the point the interval is cleared if the interval
-   * is running at that time. Defaults to `false`.
-   * @returns {IInterval} An interface for manipulating the created interval.
-   * @memberof IScheduleActions
-   */
-  interval(action: () => mixed, period: number, options?: Options): IInterval;
-
-  /**
-   * Request an animation frame.
-   *
-   * An animation frame request tells the browser that you wish to perform an
-   * animation and requests that the browser call a specified function to
-   * update an animation before the next repaint.
-   * @param {(time: DOMHighResTimeStamp) => void} action The action to be invoked before the repaint.
-   * @param {boolean} [autoSchedule] Whether or not to make the request as soon
-   * as this call is made, or wait until `set` is explicitly called. Defaults
-   * to `true`.
-   * @param {boolean} [resolveOnClear] Whether or not the associated action
-   * will be invoked at the point the request is cleared if it has not yet
-   * executed. Defaults to `false`.
-   * @returns {IAnimationFrame} An interface for manipulating the created
-   * request.
-   * @memberof IScheduleActions
-   */
-  animationFrame(
-    action: (time: DOMHighResTimeStamp) => void,
-    options?: Options
-  ): IAnimationFrame;
-
-  /**
-   * Clears all timeouts, intervals, and animation frame requests that were
-   * made with this scheduler.
-   * @memberof IScheduleActions
-   */
-  clearAll(): void;
-}
-/**
- * A props object type that can be spread into the a componenet wrapped with
- * the `withActionScheduler` higher order component.
- */
-export type WithActionSchedulerProps = $ReadOnly<{|
-  /**
-   * An instance of the `IScheduleActions` API to use for scheduling
-   * intervals, timeouts, and animation frame requests.
-   */
-  schedule: IScheduleActions,
-|}>;
-export type WithoutActionScheduler<TProps: { ... }> = $Diff<
-  TProps,
-  { schedule: any }
->;
-/**
- * Extends the given props with props that the `withActionScheduler` higher
- * order component will inject.
- */
-export type WithActionScheduler<TOwnProps: { ... }> = {|
-  ...TOwnProps,
-  ...WithActionSchedulerProps,
-|};

package/dist/util/types.typestest.js.flow

@@ -1,6 +0,0 @@
-/**
- * Flowtype definitions for data
- * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.21.0
- * @flow
- */