dnscontrol/documentation/functions/record/LOC_BUILDER_DD.md
Jeffrey Cafferata 7977a7b81c
DOCS: Improve consistency in code examples in language reference (#2439)
Co-authored-by: Tom Limoncelli <tal@whatexit.org>
2023-06-17 08:58:17 -04:00

1.8 KiB
Raw Blame History

name parameters parameters_object parameter_types
LOC_BUILDER_DD
label
x
y
alt
ttl
true
label x y alt ttl
string? number number number? Duration?

LOC_BUILDER_DD({}) actually takes an object with the following properties:

  • label (optional, defaults to @)
  • x (float32)
  • y (float32)
  • alt (float32, optional)
  • ttl (optional)

A helper to build LOC records. Supply four parameters instead of 12.

Internally assumes some defaults for LOC records.

The cartesian coordinates are decimal degrees, like you typically find in e.g. Google Maps.

Examples.

Big Ben: 51.50084265331501, -0.12462541415599787

The White House: 38.89775977858357, -77.03655125982903

{% code title="dnsconfig.js" %}

D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
    LOC_BUILDER_DD({
    label: "big-ben",
    x: 51.50084265331501,
    y: -0.12462541415599787,
    alt: 6,
  })
  , LOC_BUILDER_DD({
    label: "white-house",
    x: 38.89775977858357,
    y: -77.03655125982903,
    alt: 19,
  })
  , LOC_BUILDER_DD({
    label: "white-house-ttl",
    x: 38.89775977858357,
    y: -77.03655125982903,
    alt: 19,
    ttl: "5m",
  })
);

{% endcode %}

Part of the series: