Skip to main content

S57

Constructors

Constructor

new S57(chartName, path): S57

Parameters

chartName

string

Name or id of the chart

path

string

Path to the ENC file

Returns

S57

Methods

getDsid()

getDsid(dsidPath?): Promise<Dsid>

Returns the DSID metadata of the chart

Parameters

dsidPath?

string

Path to the DSID GeoJSON file

Returns

Promise<Dsid>


read()

read(rebuild?): Promise<MBTilesReader>

Reads the ENC dataset and generates the derived outputs in the ./tiles directory:

  • Vector tiles as an MBTiles file
  • DSID metadata as a JSON file

Parameters

rebuild?

boolean = false

Whether to rebuild the ENC dataset even if cached outputs exist

Returns

Promise<MBTilesReader>

An MBTilesReader instance for accessing the generated MBTiles