Type Alias GpsOptions

Type declaration

• false
• {
      ackTimeoutMs?: number;
      autoStart?: boolean;
      deviceId?: string;
      field?: string;
      heartbeatMs?: number;
      highAccuracy?: boolean;
      label?: string;
      maxAccuracyMeters?: number;
      maxStaleMs?: number;
      minDistanceMeters?: number;
      slice: number | string;
      socketUrl?: string;
      source?: string;
      timeoutMs?: number;
      trackingId?: string;
      waitForAck?: boolean;
      watchdogMs?: number;
  }

  • OptionalackTimeoutMs?: number

    Ack wait timeout when waitForAck is true. Default is 15000

  • OptionalautoStart?: boolean

    Start browser GPS automatically after a token is available. Set false when an app already owns GPS collection and only wants api.gps.send(...).

  • OptionaldeviceId?: string

    Stable device ID. Default is stored in localStorage

  • Optionalfield?: string

    Field key used by socket-server GPS storage. Default is coords

  • OptionalheartbeatMs?: number

    Send a heartbeat even when the GPS position has not changed. Default is 5000

  • OptionalhighAccuracy?: boolean

    Use browser high-accuracy GPS. Default is true

  • Optionallabel?: string

    Human-readable label passed through to listeners

  • OptionalmaxAccuracyMeters?: number

    Do not send non-heartbeat positions worse than this accuracy. Default is 200

  • OptionalmaxStaleMs?: number

    Reject GPS fixes older than this. Default is 4000

  • OptionalminDistanceMeters?: number

    Minimum movement before sending a non-heartbeat update. Default is 3

  • slice: number | string

    Slice used by socket-server GPS storage

  • OptionalsocketUrl?: string

    Dedicated GPS socket URL override. Defaults to the standard socket-server URL

  • Optionalsource?: string

    Source/app label passed through to listeners

  • OptionaltimeoutMs?: number

    Browser geolocation timeout. Default is 10000

  • OptionaltrackingId?: string

    Stable tracking ID for the object/person/vehicle being tracked.

    If omitted, datalynk-client generates a unique tracker ID for this Gps instance. The default tracking ID is intentionally not based on sessionId, because one logged-in session/device may start more than one active tracker.

  • OptionalwaitForAck?: boolean

    Wait for socket-server ack on manual send(). Default is false

  • OptionalwatchdogMs?: number

    Restart watchPosition if no fresh fix arrives. Default is 60000