@types/enquire.js v2.1.5

Installation

npm install --save @types/enquire.js

Summary

This package contains type definitions for enquire.js (https://github.com/WickyNilliams/enquire.js/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/enquire.js.

index.d.ts

// 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 | undefined;
    /**
     * 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;

Additional Details

• Last updated: Thu, 08 Jul 2021 12:01:08 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Christian Rackerseder.