Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.06 KB

README.md

File metadata and controls

45 lines (29 loc) · 2.06 KB
Raw

Navigation API Types

npm

Type definition for Navigation API

Install

$ npm i -D navigation-api-types

Usage

Make types visible in specific files

Add a TypesScript triple-slash directive as follows in any code-containing '.ts' file you want these types to be available in:

// Add types for window.navigation for use in this file. See https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html#-reference-types- for more info.
/// <reference types="navigation-api-types" />

console.log(window.navigation) // no type error!

Make types visible globally in all source files within a project

Create a .d.ts file anywhere in your project so that it is visible to TypeScript according to your tsconfig.json settings. For example, it could be at src/global.d.ts or src/navigation-api-types.d.ts.

Add a TypesScript triple-slash directive as follows:

// Add types for window.navigation ambiently for implicit use in the entire project. See https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html#-reference-types- for more info.
/// <reference types="navigation-api-types" />

This exposes the types ambiently so they are available without any import or require statements. TypeScript will simply know about them everywhere.

Important: do not add any import or export statements to this file, or it will stop working ambiently. Doing that changes it in TypeScript's view from a "script" to a "module", and the rules about ambient types change in that case.

License

This project is licensed under the MIT License.