dnscontrol/documentation/language-reference/domain-modifiers/LOC_BUILDER_DMM_STR.md
2024-12-17 07:46:37 -05:00

53 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
name: LOC_BUILDER_DMM_STR
parameters:
- label
- str
- alt
- ttl
parameters_object: true
parameter_types:
label: string?
str: string
alt: number?
ttl: Duration?
---
`LOC_BUILDER_DMM({})` actually takes an object with the following properties:
- label (string, optional, defaults to `@`)
- str (string)
- alt (float32, optional)
- ttl (optional)
A helper to build [`LOC`](LOC.md) records. Supply three parameters instead of 12.
Internally assumes some defaults for [`LOC`](LOC.md) records.
Accepts a string with decimal minutes (DMM) coordinates in the form: 25.24°S 153.15°E
Note that the following are acceptable forms (symbols differ):
* `25.24°S 153.15°E`
* `25.24 S 153.15 E`
* `25.24° S 153.15° E`
* `25.24S 153.15E`
{% code title="dnsconfig.js" %}
```javascript
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
LOC_BUILDER_STR({
label: "tasmania",
str: "42°S 147°E",
alt: 3,
}),
);
```
{% endcode %}
Part of the series:
* [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters
* [`LOC_BUILDER_DD({})`](LOC_BUILDER_DD.md) - accepts cartesian x, y
* [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°5131″S 151°1251″E
* [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
* [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries the coordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works