Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AerisWeather

The main entry point for interacting with AerisWeather API services.

Hierarchy

  • AerisWeather

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Initializes an AerisWeather instance configured with the specified client id and secret.

    Parameters

    • id: string
    • secret: string
    • Optional servers: Servers

    Returns AerisWeather

Accessors

utils

  • get utils(): {}
  • Provides access to the library's utility functions.

    General utility functions are accessible at the root of the utils object, but additional functions are available for specific data types, such as colors, strings, etc:

    • utils.strings: String-related utility functions
    • utils.colors: Color-related utility functions
    • utils.dates: Date-related utility functions
    readonly
    memberof

    AerisWeather

    Returns {}

    • [key: string]: Function | {}

Methods

account

  • Returns the Account instance used when performing API requests.

    Returns Account

api

  • Creates and returns a new ApiRequest configured for the current account.

    memberof

    AerisWeather

    Parameters

    Returns ApiRequest

apps

  • apps(callback?: (apps: any) => void): Promise<any>
  • Provides access to the apps module of the library.

    The apps module is loaded asynchronously using this method, which means you'll need to wait for it to be loaded before working with any of its features. You can use the Promise that's returned, or provide a callback function as a parameter to be notified once the module is available.

    memberof

    AerisWeather

    Parameters

    • Optional callback: (apps: any) => void
        • (apps: any): void
        • Parameters

          • apps: any

          Returns void

    Returns Promise<any>

map

  • Creates and returns a new MapRequest configured for the current account.

    memberof

    AerisWeather

    Parameters

    Returns MapRequest

mapsgl

modules

  • modules(callback?: (modules: any) => void): Promise<any>
  • Provides access to the external modules library.

    The modules library is loaded asynchronously using this method, which means you'll need to wait for it to be loaded before working with any of its features. You can use the Promise that's returned, or provide a callback function as a parameter to be notified once the library is available.

    memberof

    AerisWeather

    Parameters

    • Optional callback: (modules: any) => void
        • (modules: any): void
        • Parameters

          • modules: any

          Returns void

    Returns Promise<any>

servers

  • Returns the API server used when performing API requests.

    Returns Servers

views

  • views(callback?: (views: any) => void): Promise<any>
  • Provides access to the views module of the library.

    The views module is loaded asynchronously using this method, which means you'll need to wait for it to be loaded before working with any of its features. You can use the Promise that's returned, or provide a callback function as a parameter to be notified once the module is available.

    memberof

    AerisWeather

    Parameters

    • Optional callback: (views: any) => void
        • (views: any): void
        • Parameters

          • views: any

          Returns void

    Returns Promise<any>

Generated using TypeDoc