Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Spotters

The Spotter Sensor API provides access to real-time weather and surface data collected by Spotter devices.

Hierarchy

  • Spotters

Index

Methods

Methods

getSpotter

  • getSpotter(spotterId: string): Promise<Spotter>

  • Retrieves a specific spotter based on the ID.

    Parameters

    • spotterId: string

      the spotter ID to retrieve.

    Returns Promise<Spotter>

    A Spotter if the spotter was found or rejects the promise with an error.

getSpotters

  • getSpotters(exludeSharedDevices?: boolean): Promise<Spotter[]>

  • Retrieve a list of Spotters you have API access to, including Spotter ID and nickname.

    Parameters

    • Default value exludeSharedDevices: boolean = false

      Set true to only return devices you own. @default false

    Returns Promise<Spotter[]>

    A list of Spotters

Generated using TypeDoc