ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update types info in README

Browse Source
This commit is contained in:
Andreas Hocevar
2021-07-05 15:02:56 +02:00
parent b9a1d6663b
commit cb4d5a7107
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -105,7 +105,7 @@ The untranspiled sources in the `src/` folder are JSDoc type annotated. For appl
## TypeScript support
When authoring in TypeScript, we recommend you try out the types that are included in the `ol` package. To use these types, make sure you have the following entry for `@types/ol` in your `package.json`'s `devDependencies` section:
When authoring in TypeScript, we recommend you try out the types that are included in the `ol` package. To use these types, add the following entry for `@types/ol` to your `package.json`'s `devDependencies` section:
```
{
...
@@ -116,7 +116,9 @@ When authoring in TypeScript, we recommend you try out the types that are includ
}
}
```
These are auto-generated with the TypeScript compiler, and will be the default in future versions. Alternatively, you can use third-party types from [Definitely Typed](https://definitelytyped.org) (`npm install @types/ol`) or from [hanreev/types-ol](https://github.com/hanreev/types-ol).
Make sure to run `npm install` before and after adding that entry.
These types are auto-generated by the TypeScript compiler, and will be the only type source in future versions. For now, you can still use third-party types from [Definitely Typed](https://definitelytyped.org) (`npm install @types/ol`) or from [hanreev/types-ol](https://github.com/hanreev/types-ol).
## Supported Browsers