054a92bbb7b4a082ac0b3e20f7e40e6a06b17d6921a6031468b95e48be95060ead5d8877b0c703ad3802e1e2e788a03d11af5e5dc727d247e729116c854055 1.3 KB

123456789101112131415161718192021222324252627282930
  1. import { Scheduler } from '../Scheduler';
  2. import { Subscription } from '../Subscription';
  3. import { SchedulerAction } from '../types';
  4. /**
  5. * A unit of work to be executed in a `scheduler`. An action is typically
  6. * created from within a {@link SchedulerLike} and an RxJS user does not need to concern
  7. * themselves about creating and manipulating an Action.
  8. *
  9. * ```ts
  10. * class Action<T> extends Subscription {
  11. * new (scheduler: Scheduler, work: (state?: T) => void);
  12. * schedule(state?: T, delay: number = 0): Subscription;
  13. * }
  14. * ```
  15. */
  16. export declare class Action<T> extends Subscription {
  17. constructor(scheduler: Scheduler, work: (this: SchedulerAction<T>, state?: T) => void);
  18. /**
  19. * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed
  20. * some context object, `state`. May happen at some point in the future,
  21. * according to the `delay` parameter, if specified.
  22. * @param state Some contextual data that the `work` function uses when called by the
  23. * Scheduler.
  24. * @param delay Time to wait before executing the work, where the time unit is implicit
  25. * and defined by the Scheduler.
  26. * @return A subscription in order to be able to unsubscribe the scheduled work.
  27. */
  28. schedule(state?: T, delay?: number): Subscription;
  29. }
  30. //# sourceMappingURL=Action.d.ts.map