interfaces.ts

/*
Copyright 2017 LinkedIn Corp. Licensed under the Apache License,
Version 2.0 (the "License"); you may not use this file except in
compliance with the License. You may obtain a copy of the License
at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/

export interface QueueElementInterface {
  callback: (frame: FrameInterface, id: string) => void;
  id: string;
}

export interface QueueDOMElementInterface {
  id: string;
  callback: (frame: FrameInterface, id: string, bcr: ClientRect) => void;
  el: Element;
}

export interface QueueInterface {
  push: (element: QueueElementInterface) => void;
  isEmpty: () => Boolean;
  remove: (id: string | Element | Function) => void;
  clear: () => void;
}

export interface EngineInterface {
  scheduleRead: (callback: Function) => void;
  scheduleWork: (callback: Function) => void;
}

export interface BaseSchedulerInterface {
  scheduleRead: (callback: Function) => void;
  scheduleWork: (callback: Function) => void;
}

export interface SchedulerInterface extends BaseSchedulerInterface {
  watch: (callback: (frame: FrameInterface) => void) => string;
}

export interface ElementSchedulerInterface extends BaseSchedulerInterface {
  watch: (el: Element, callback: (frame: FrameInterface, id: string, bcr: ClientRect) => void, id?: string) => string;
}

export interface FrameInterface {
  timestamp: number;
  scrollTop: number;
  scrollLeft: number;
  x: number;
  y: number;
  width: number;
  height: number;
}