Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukewarlow/navigation-api-types
TypeScript definition for the Navigation API
https://github.com/lukewarlow/navigation-api-types
app-history-api hacktoberfest history-api navigation-api types typescript typescript-definitions
Last synced: 29 days ago
JSON representation
TypeScript definition for the Navigation API
- Host: GitHub
- URL: https://github.com/lukewarlow/navigation-api-types
- Owner: lukewarlow
- License: mit
- Created: 2022-04-22T16:49:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-30T13:06:23.000Z (12 months ago)
- Last Synced: 2024-10-05T09:24:22.217Z (about 1 month ago)
- Topics: app-history-api, hacktoberfest, history-api, navigation-api, types, typescript, typescript-definitions
- Homepage: https://www.npmjs.com/package/navigation-api-types
- Size: 18.6 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Navigation API Types
[](https://www.npmjs.com/package/navigation-api-types)
Type definition for [`Navigation API`](https://developer.mozilla.org/en-US/docs/Web/API/Navigation_API)
### Install
```shell
$ npm i -D navigation-api-types
```
### Usage
#### Make types visible in specific files
Add a [TypesScript triple-slash directive](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html#-reference-types-)
as follows in any code-containing '.ts' file you want these types to be available in:
```typescript
// 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.
///
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](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html#-reference-types-) as follows:
```typescript
// 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.
///
```
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](https://github.com/lukewarlow/navigation-api-types/blob/master/LICENSE).