Sha256: d145f87a4e3e193a6796a011b2ee1148d73f9e99cd3a77fb6a3d8b0162d69409

Contents?: true

Size: 1.21 KB

Versions: 49

Compression:

Stored size: 1.21 KB

Contents

import { Scheduler } from '../Scheduler';
import { Subscription } from '../Subscription';

/**
 * A unit of work to be executed in a {@link Scheduler}. An action is typically
 * created from within a Scheduler and an RxJS user does not need to concern
 * themselves about creating and manipulating an Action.
 *
 * ```ts
 * class Action<T> extends Subscription {
 *   new (scheduler: Scheduler, work: (state?: T) => void);
 *   schedule(state?: T, delay: number = 0): Subscription;
 * }
 * ```
 *
 * @class Action<T>
 */
export class Action<T> extends Subscription {
  constructor(scheduler: Scheduler, work: (this: Action<T>, state?: T) => void) {
    super();
  }
  /**
   * Schedules this action on its parent Scheduler for execution. May be passed
   * some context object, `state`. May happen at some point in the future,
   * according to the `delay` parameter, if specified.
   * @param {T} [state] Some contextual data that the `work` function uses when
   * called by the Scheduler.
   * @param {number} [delay] Time to wait before executing the work, where the
   * time unit is implicit and defined by the Scheduler.
   * @return {void}
   */
  public schedule(state?: T, delay: number = 0): Subscription {
    return this;
  }
}

Version data entries

49 entries across 49 versions & 4 rubygems

Version Path
ilog-0.4.1 node_modules/rxjs/src/scheduler/Action.ts
ilog-0.4.0 node_modules/rxjs/src/scheduler/Action.ts
ilog-0.3.3 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-18.0.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.21.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.20.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.19.1 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.19.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.18.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.17.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.16.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.15.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.14.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.13.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.12.2 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.12.1 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.12.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.11.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.10.0 node_modules/rxjs/src/scheduler/Action.ts
govuk_publishing_components-17.9.0 node_modules/rxjs/src/scheduler/Action.ts