dnscontrol/documentation/functions/record/LOC_BUILDER_STR.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_STR
label
str
alt
ttl
true
label str alt ttl
string? string number? Duration?

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

  • label (optional, defaults to @)
  • str (string)
  • alt (float32, optional)
  • ttl (optional)

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

Internally assumes some defaults for LOC records.

Accepts a string and tries all LOC_BUILDER_DM*_STR({}) methods:

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

D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
  , LOC_BUILDER_STR({
    label: "old-faithful",
    str: "44.46046°N 110.82815°W",
    alt: 2240,
  })
  , LOC_BUILDER_STR({
    label: "ribblehead-viaduct",
    str: "54.210436°N 2.370231°W",
    alt: 300,
  })
  , LOC_BUILDER_STR({
    label: "guinness-brewery",
    str: "53°2040″N 6°1720″W",
    alt: 300,
  })
);

{% endcode %}

Part of the series: