Class WxAPI

Extends the BaseWxAPI class from the @metoceanapi/wxtiles-common package. Provides additional functionality for creating dataset managers.

Hierarchy

  • WxAPI
    • WxAPI

Constructors

constructor

Methods

createDatasetManager

Constructors

constructor

  • Initializes a new instance of the WxAPI class.

    Parameters

    • options: WxAPIOptions

      Configuration options for the WxAPI instance. See WxAPIOptions.

    Returns WxAPI

Methods

createDatasetManager

  • Creates a dataset manager for the specified dataset.

    Returns

    A promise that resolves to a WxDataSetManager instance.

    Example

    const api = new WxAPI();
    const datasetManager = await api.createDatasetManager("gfs.global");

    Parameters

    • datasetName: string

      The name of the dataset to manage.

    Returns Promise<WxDataSetManager>

Settings

Member Visibility

Theme

Generated using TypeDoc