DefinitelyTyped/types/enquire.js/index.d.ts
Nathan Shively-Sanders f0ce987bc1 Update project urls to match NPM url
Note that this *trivially* updates project urls by adding the NPM url to
the end, even when the urls are almost identical or the DT one is
outdated. I'll clean up the urls in a later commit.

This PR is unfinished! Please do not merge it yet.
2019-02-11 17:10:55 -08:00

44 lines
1.2 KiB
TypeScript

// Type definitions for enquire.js 2.1
// Project: https://github.com/WickyNilliams/enquire.js/, http://wicky.nillia.ms/enquire.js
// Definitions by: Christian Rackerseder <https://github.com/screendriver>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.6
interface Options {
/**
* If set to true, defers execution of the setup function until the first time the media query is matched
*/
deferSetup?: boolean;
/**
* If supplied, triggered when a media query matches.
*/
match?(): void;
/**
* If supplied, triggered when the media query transitions from a matched state to an unmatched state.
*/
unmatch?(): void;
/**
* If supplied, triggered once, when the handler is registered.
*/
setup?(): void;
/**
* If supplied, triggered when handler is unregistered. Place cleanup code here
*/
destroy?(): void;
}
type Callback = () => void;
interface EnquireJs {
register(
mediaQuery: string,
options: Options | Options[] | Callback,
shouldDegrade?: boolean,
): EnquireJs;
unregister(mediaQuery: string, handler?: Callback | Options): void;
}
declare const enquire: EnquireJs;
export = enquire;