Skip to content

Commit

Permalink
Fix default workerCount in docs (mapbox#10376)
Browse files Browse the repository at this point in the history
  • Loading branch information
andycalder authored Feb 11, 2021
1 parent a45ca32 commit 0102e52
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -120,13 +120,13 @@ const exported = {

/**
* Gets and sets the number of web workers instantiated on a page with GL JS maps.
* By default, it is set to half the number of CPU cores (capped at 6).
* By default, it is set to 2.
* Make sure to set this property before creating any map instances for it to have effect.
*
* @var {string} workerCount
* @returns {number} Number of workers currently configured.
* @example
* mapboxgl.workerCount = 2;
* mapboxgl.workerCount = 4;
*/
get workerCount(): number {
return WorkerPool.workerCount;
Expand Down

0 comments on commit 0102e52

Please sign in to comment.