@types/mapbox__mapbox-gl-traffic 1.0.0

mapbox__mapbox-gl-traffic/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

mapbox__mapbox-gl-traffic/README.md

@@ -0,0 +1,74 @@
+# Installation
+> `npm install --save @types/mapbox__mapbox-gl-traffic`
+
+# Summary
+This package contains type definitions for @mapbox/mapbox-gl-traffic (https://github.com/mapbox/mapbox-gl-traffic).
+
+# Details
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-gl-traffic.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-gl-traffic/index.d.ts)
+````ts
+// Type definitions for @mapbox/mapbox-gl-traffic 1.0
+// Project: https://github.com/mapbox/mapbox-gl-traffic
+// Definitions by: Niek van Bennekom <https://github.com/niekvb>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference types="mapbox-gl" />
+/// <reference types="node" />
+
+export as namespace MapboxTraffic;
+export = MapboxTraffic;
+
+declare class MapboxTraffic {
+    /**
+     * Create a new [Mapbox GL JS plugin](https://www.mapbox.com/blog/build-mapbox-gl-js-plugins/) that allows you to hide and show
+     * traffic layers in your map and an optional toggle button.
+     *
+     * @param options - Options to configure the plugin.
+     */
+    constructor(options?: MapboxTraffic.Options);
+    _hasTraffic(): boolean;
+    _hideTraffic(): void;
+    _showTraffic(): void;
+    onAdd(map: mapboxgl.Map): HTMLDivElement;
+    onRemove(): void;
+    render(): void;
+    /**
+     * Toggle visibility of traffic layer.
+     */
+    toggleTraffic(): void;
+}
+
+declare namespace MapboxTraffic {
+    /** Options to configure the `MapboxTraffic` plugin. */
+    interface Options {
+        /**
+         * Show or hide traffic overlay by default.
+         *
+         * @default false
+         */
+        showTraffic?: boolean;
+        /**
+         * Show a toggle button to turn traffic on and off.
+         *
+         * @default true
+         */
+        showTrafficButton?: boolean;
+        /**
+         * The traffic source regex used to determine whether a layer displays traffic or not.
+         *
+         * @default /mapbox-traffic-v\d/
+         */
+        trafficSource?: RegExp;
+    }
+}
+
+````
+
+### Additional Details
+ * Last updated: Thu, 14 Apr 2022 06:01:17 GMT
+ * Dependencies: [@types/mapbox-gl](https://npmjs.com/package/@types/mapbox-gl), [@types/node](https://npmjs.com/package/@types/node)
+ * Global values: `MapboxTraffic`
+
+# Credits
+These definitions were written by [Niek van Bennekom](https://github.com/niekvb).

mapbox__mapbox-gl-traffic/index.d.ts

@@ -0,0 +1,54 @@
+// Type definitions for @mapbox/mapbox-gl-traffic 1.0
+// Project: https://github.com/mapbox/mapbox-gl-traffic
+// Definitions by: Niek van Bennekom <https://github.com/niekvb>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference types="mapbox-gl" />
+/// <reference types="node" />
+
+export as namespace MapboxTraffic;
+export = MapboxTraffic;
+
+declare class MapboxTraffic {
+    /**
+     * Create a new [Mapbox GL JS plugin](https://www.mapbox.com/blog/build-mapbox-gl-js-plugins/) that allows you to hide and show
+     * traffic layers in your map and an optional toggle button.
+     *
+     * @param options - Options to configure the plugin.
+     */
+    constructor(options?: MapboxTraffic.Options);
+    _hasTraffic(): boolean;
+    _hideTraffic(): void;
+    _showTraffic(): void;
+    onAdd(map: mapboxgl.Map): HTMLDivElement;
+    onRemove(): void;
+    render(): void;
+    /**
+     * Toggle visibility of traffic layer.
+     */
+    toggleTraffic(): void;
+}
+
+declare namespace MapboxTraffic {
+    /** Options to configure the `MapboxTraffic` plugin. */
+    interface Options {
+        /**
+         * Show or hide traffic overlay by default.
+         *
+         * @default false
+         */
+        showTraffic?: boolean;
+        /**
+         * Show a toggle button to turn traffic on and off.
+         *
+         * @default true
+         */
+        showTrafficButton?: boolean;
+        /**
+         * The traffic source regex used to determine whether a layer displays traffic or not.
+         *
+         * @default /mapbox-traffic-v\d/
+         */
+        trafficSource?: RegExp;
+    }
+}

mapbox__mapbox-gl-traffic/package.json

@@ -0,0 +1,28 @@
+{
+    "name": "@types/mapbox__mapbox-gl-traffic",
+    "version": "1.0.0",
+    "description": "TypeScript definitions for @mapbox/mapbox-gl-traffic",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-gl-traffic",
+    "license": "MIT",
+    "contributors": [
+        {
+            "name": "Niek van Bennekom",
+            "url": "https://github.com/niekvb",
+            "githubUsername": "niekvb"
+        }
+    ],
+    "main": "",
+    "types": "index.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/mapbox__mapbox-gl-traffic"
+    },
+    "scripts": {},
+    "dependencies": {
+        "@types/mapbox-gl": "*",
+        "@types/node": "*"
+    },
+    "typesPublisherContentHash": "abcd9fc7667e376df8b84caf0fcca957e52f387a55c0fb33fa68528bbb517b9a",
+    "typeScriptVersion": "3.9"
+}