api/rains/:id

Hierarchy (view full)

Constructors

  • Parameters

    • json: {
          id: string;
          name: string;
          team: string | TeamNode;
          description?: string;
          links?: Link[] | RaainNode[];
          version?: string;
          status?: number;
          quality?: number;
          radars?: string[] | RadarNode[];
          gauges?: string[] | GaugeNode[];
          latLngRectsAsJSON?: string;
          configurationAsJSON?: string;
          lastCompletedComputations?: string[] | RainComputation[];
      }
      • id: string
      • name: string
      • team: string | TeamNode
      • Optional description?: string
      • Optional links?: Link[] | RaainNode[]
      • Optional version?: string
      • Optional status?: number
      • Optional quality?: number
      • Optional radars?: string[] | RadarNode[]
      • Optional gauges?: string[] | GaugeNode[]
      • Optional latLngRectsAsJSON?: string
      • Optional configurationAsJSON?: string
      • Optional lastCompletedComputations?: string[] | RainComputation[]

    Returns RainNode

Properties

id: string

Unique identifier for the node

version: string

Version string of the node

TYPE: string = 'rain'
name: string
description: string
team: TeamNode
status: number
quality: number
latLngRectsAsJSON: string

Accessors

Methods

  • Gets the count of links, optionally filtered by type.

    Parameters

    • Optional linkType: string

      Optional type of links to count

    Returns number

    The number of links

  • Parameters

    • configuration: any

    Returns void

  • Converts the node to a JSON object.

    Returns {
        id: string;
        links: Link[];
        version?: string;
        name: string;
        description: string;
        status: number;
        quality: number;
        team: string | TeamNode;
        latLngRectsAsJSON: string;
        configurationAsJSON: string;
        radars: string[];
        gauges: string[];
        lastCompletedComputations: string[];
    }

    A JSON object containing the node's data

    • id: string
    • links: Link[]
    • Optional version?: string
    • name: string
    • description: string
    • status: number
    • quality: number
    • team: string | TeamNode
    • latLngRectsAsJSON: string
    • configurationAsJSON: string
    • radars: string[]
    • gauges: string[]
    • lastCompletedComputations: string[]