Merge pull request #8 from rob2d/typescript-defs-and-webpack-5

Typescript support and Webpack 5 Builds

Author: rob2d

build/index.d.ts

@@ -0,0 +1,19 @@
+declare module 'use-viewport-sizes' {
+    /**
+     * Hook which observes viewport dimensions. Returns [width, height] of
+     * current visible viewport of app.
+     *
+     * If no input specified, returns the [width, height] when the window changes.
+     *
+     * If input is specified as a number, it interprets this as the number of
+     * miliseconds to debounce before updates.
+     *
+     * If the input is specified as a function, it accepts a callback
+     * with the viewport width and height passed in the first arg as
+     * { vpW, vpH }, and will only return a new value and update when
+     * the hash-value returned changes.
+     */
+    export default function(
+        input:number | (({ vpW: number, vpH: number }) => String)
+    ):[vpW: number, vpH: number];
+}