wnr / element-resize-detector

Optimized cross-browser resize listener for elements.
MIT License
1.32k stars 118 forks source link

TypeScript Definition #76

Closed jinder closed 7 years ago

jinder commented 7 years ago

Any chance of shipping a TS definition with the library? Definition below (adapted from SO):

declare interface ErdmOptions {
  strategy?: "scroll" | "object";
}

declare interface ElementResizeDetector {
  listenTo<T extends HTMLElement>(element: T, callback: (elem: T) => void): void;
  removeListener<T extends HTMLElement>(element: T, callback: (elem: T) => void): void;
  removeAllListeners(element: HTMLElement): void;
  uninstall(element: HTMLElement): void;
}

declare module "element-resize-detector" {
  const elementResizeDetectorMaker: (options?: ErdmOptions) => ElementResizeDetector;

  export = elementResizeDetectorMaker;
}
wnr commented 7 years ago

No sorry. Perhaps a project element-resize-detector-ts or similar can be created to support this (similar to the ember/angular/react/vue/etc versions of this project). I don't like the idea of this project supporting the union of all frameworks/languages that web developers use.

saranshkataria commented 6 years ago

Have created a @types definition for this: https://www.npmjs.com/package/@types/element-resize-detector