user-agent-data-types - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

package.json

 {
   "name": "user-agent-data-types",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Type definition for navigator.userAgentData",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -13,18 +13,35 @@ # User Agent Data Types
 
-### tsconfig.json
+### Usage
 
-`user-agent-data-types` needs to be added to `types` because it uses _ambient_ types that modify the global `navigator` type.
+#### Make types visible in specific files
 
-```json
-{
-  "compilerOptions": {
-    "types": [
-        "./node_modules/user-agent-data-types"
-    ]
-  }
-}
+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 data types to window.navigator for use in this file. See https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html#-reference-types- for more info.
+/// <reference types="user-agent-data-types" />
+
+console.log(window.navigator.userAgentData) // 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/user-agent-data-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 data types to window.navigator 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="user-agent-data-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](https://github.com/lukewarlow/user-agent-data-types/blob/master/LICENSE).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5011

increased by39.27%

Number of lines in readme file

47

increased by56.67%

No dependency changes