Options
All
  • Public
  • Public/Protected
  • All
Menu

SOFAR API SDK - v1.0.4

Index

Classes

Type aliases

Type aliases

ModelAvailabilityRequest

ModelAvailabilityRequest: { clostest?: Date; end?: Date; modelID: string; start?: Date }

Parameter type to request Marine Weather Model Data Availability.

Type declaration

  • Optional clostest?: Date

    Can be used to find the nearest timestamp when data is available for the model.

  • Optional end?: Date

    The end of the requested time frame. Must be greater or equal to . Required if start provided.

  • modelID: string

    The ID of the model for which you want to retrieve data.

  • Optional start?: Date

    The beginning of the requested time frame.

SpotterWave

SpotterWave: { latitude: number; longitude: number; meanDirection: number; meanDirectionalSpread: number; meanPeriod: number; peakDirection: number; peakDirectionalSpread: number; peakPeriod: number; significantWaveHeight: number; timestamp: Date }

Type declaration

  • latitude: number

    Unit: decimal degrees

  • longitude: number

    Unit: decimal degrees

  • meanDirection: number

    Unit: degrees

  • meanDirectionalSpread: number
  • meanPeriod: number

    Unit: seconds

  • peakDirection: number

    Unit: degrees

  • peakDirectionalSpread: number
  • peakPeriod: number

    Unit: seconds

  • significantWaveHeight: number

    Unit: meters.

  • timestamp: Date

SpotterWaveDataRequest

SpotterWaveDataRequest: { includeDirectionalMoments: boolean; includeFrequencyData: boolean; includeWindData: boolean }

Parameter type to request spotter wave data.

Type declaration

  • includeDirectionalMoments: boolean

    Include spectrally binned directional moments. Only applies if Spotter is in Full Waves Mode.

    default

    false

  • includeFrequencyData: boolean

    Include spectrally binned surface variance, direction, and directional spreading. Only applies for samples collected in Full Waves Mode.

    default

    false

  • includeWindData: boolean

    Include derived wind speed and direction in response.

    default

    false

SpotterWind

SpotterWind: { direction: number; latitude: number; longitude: number; seasurfaceId: number; speed: number; timestamp: Date }

Type declaration

  • direction: number

    Unit: degrees

  • latitude: number

    Unit: decimal degrees

  • longitude: number

    Unit: decimal degrees

  • seasurfaceId: number
  • speed: number

    Unit: m/s

  • timestamp: Date

Generated using TypeDoc