Installations

npm install @hanreev/types-ol

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

16.19.0

NPM Version

8.19.3 Score

70.4

Supply Chain

99.5

Quality

76.2

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

2

Total

19

Closed

12

Merged

5

Issues

Open

0

Total

19

Closed

19

Releases

32

v7.2.0

Published on 10 Jan 2023

v7.1.0

Published on 16 Nov 2022

v6.15.0

Published on 16 Nov 2022

@hanreev/types-ol v3.9.1

3.9.1

Published on 30 Nov 2021

@hanreev/types-ol v3.9.0

3.9.0

Published on 29 Nov 2021

@hanreev/types-ol v3.8.0

3.8.0

Published on 29 Nov 2021

View all 32 releases

Contributors

1

Unable to fetch Contributors

View all 1 contributors

Languages

3

TypeScript

JavaScript

Shell

TypeScript (83.44%)

JavaScript (16.54%)

Shell (0.02%)

Developer

hanreev

Download Statistics

Total Downloads

109,112

Last Day

1

Last Week

65

Last Month

445

Last Year

12,390

GitHub Statistics

35 Stars

149 Commits

9 Forks

5 Watching

5 Branches

1 Contributors

Maintainers

1

Package Meta Information

Latest Version

7.2.0

Package Id

@hanreev/types-ol@7.2.0

Unpacked Size

679.44 kB

Size

131.13 kB

File Count

344

NPM Version

8.19.3

Node Version

16.19.0

Publised On

10 Jan 2023

Total Downloads

Cumulative downloads

Total Downloads

109,112

Last day

-66.7%

1

Compared to previous day

Last week

-52.6%

65

Compared to previous week

Last month

-39.5%

445

Compared to previous month

Last year

-24.6%

12,390

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

6

@types/arcgis-rest-api @types/geojson @types/pbf @types/rbush @types/topojson-specification geotiff

Dev Dependencies

29

Versions

OpenLayers TypeScript Definition

~~Definitions from this project will be syncronized with official @types/ol package.~~

As of v6.6.0, OpenLayers has officially provided its own TypeScript definitions. Installation of third party package like @hanreev/types-ol or @types/ol may no longer be needed.

This project contains TypeScript definition for OpenLayers v6.x.x that includes all documented API and protected class members and methods. Check v5.3.x branch for OpenLayers v5.3.x definitions.

Installation

1# NPM
2npm i -D @hanreev/types-ol
3
4# Yarn
5yarn add -D @hanreev/types-ol

Development version

1# NPM
2npm i -D @hanreev/types-ol@dev
3
4# Yarn
5yarn add -D @hanreev/types-ol@dev

Usage

Add ol and ol/* to compilerOptions.paths in tsconfig.json

1// file: tsconfig.json
2
3{
4  "compilerOptions": {
5    ...
6    "baseUrl": "./",
7    "paths": {
8      "ol": ["node_modules/@hanreev/types-ol/ol"],
9      "ol/*": ["node_modules/@hanreev/types-ol/ol/*"]
10    },
11    ...
12  }
13}

Configuring and Building TypeScript definition files

Configuration is located at jsdoc/conf.json

1// file: jsdoc/conf.json
2
3{
4  "source": {
5    ...
6    "include": [
7      "openlayers/src/ol" // openlayers source
8    ]
9  },
10  ...
11  "typescript": {
12    "moduleRoot": "openlayers/src", // openlayers source
13    "definition": {
14      "strictReturnTypes": false // set to true to include undefined and null return.
15    }
16  },
17  ...
18}

Install all dependencies
```
1# NPM
2npm i
3
4# Yarn
5yarn install
```

Run build

1# NPM
2npm run build-format && npm run lint
3
4# Yarn
5yarn build-format && yarn lint

Run test

1# NPM
2npm run lint-test && npm run test
3
4# Yarn
5yarn lint-test && yarn test

Note:
Some definitions were patched manually. If you found any error please create a new issue.

Changelog

CHANGELOG.md

License

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More