Interface AnimationController

src/index.ts:14–39

 * Allows start/stop control of the animation
 */
export interface AnimationController<P = unknown> {
  /**
   * The original animation parent.
   */
  readonly parent: Element
  /**
   * A function that enables future animations.
   */
  enable: () => void
  /**
   * A function that disables future animations.
   */
  disable: () => void
  /**
   * A function that returns true if the animations are currently enabled.
   */
  isEnabled: () => boolean
  /**
   * (Svelte Specific) A function that runs if the parameters are changed.
   */
  update?: (newParams: P) => void
  /**
   * (Svelte Specific) A function that runs when the component is removed from the DOM.
   */
  destroy?: () => void
}

/**
 * A set of all the parents currently being observe. This is the only non weak