Skip to content

Commit

Permalink
Fix documentation of addProtocol and remove version docs (#779)
Browse files Browse the repository at this point in the history
* Fix documentation of `addProtocol` and remove `version` docs

* Bump to v2.0.1
  • Loading branch information
wipfli authored Jan 15, 2022
1 parent 1e14690 commit 7ed6af7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@

- *...Add new stuff here...*

## 2.0.1

### 🐞 Bug fixes

- Fix documentation of `addProtocol` and `removeProtocol`.

## 2.0.0

### Features and improvements
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "maplibre-gl",
"description": "BSD licensed community fork of mapbox-gl, a WebGL interactive maps library",
"version": "2.0.0",
"version": "2.0.1",
"main": "dist/maplibre-gl.js",
"style": "dist/maplibre-gl.css",
"license": "BSD-3-Clause",
Expand Down
11 changes: 4 additions & 7 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,8 @@ const exported = {
* The example below will be triggered for custom:// urls defined in the sources list in the style definitions.
* The function passed will receive the request parameters and should call the callback with the resulting request,
* for example a pbf vector tile, non-compressed, represented as ArrayBuffer.
*
* @function addProtocol
* @param {string} customProtocol - the protocol to hook, for example 'custom'
* @param {Function} loadFn - the function to use when trying to fetch a tile specified by the customProtocol
* @example
Expand Down Expand Up @@ -176,6 +178,8 @@ const exported = {

/**
* Removes a previusly added protocol
*
* @function removeProtocol
* @param {string} customProtocol - the custom protocol to remove registration for
* @example
* maplibregl.removeProtocol('custom');
Expand All @@ -188,13 +192,6 @@ const exported = {
//This gets automatically stripped out in production builds.
Debug.extend(exported, {isSafari, getPerformanceMetrics: PerformanceUtils.getPerformanceMetrics});

/**
* The version of MapLibre GL JS in use as specified in `package.json`,
* `CHANGELOG.md`, and the GitHub release.
*
* @var {string} version
*/

/**
* Test whether the browser supports MapLibre GL JS.
*
Expand Down

0 comments on commit 7ed6af7

Please sign in to comment.