dnscontrol/documentation/functions/record/LOC_BUILDER_STR.md

63 lines
1.8 KiB
Markdown
Raw Normal View History

2023-03-17 11:04:13 +08:00
---
name: LOC_BUILDER_STR
parameters:
- label
- str
- alt
- ttl
parameters_object: true
2023-03-17 11:04:13 +08:00
parameter_types:
label: string?
2023-03-17 11:04:13 +08:00
str: string
alt: number?
ttl: Duration?
2023-03-17 11:04:13 +08:00
---
`LOC_BUILDER_STR({})` actually takes an object with the following: properties.
- label (optional, defaults to `@`)
- str (string)
- alt (float32, optional)
2023-03-17 11:04:13 +08:00
- ttl (optional)
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
Internally assumes some defaults for [`LOC`](../domain/LOC.md) records.
Accepts a string and tries all `LOC_BUILDER_DM*_STR({})` methods:
* [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°5131″S 151°1251″E
* [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
{% code title="dnsconfig.js" %}
```javascript
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
2023-03-17 11:04:13 +08:00
, LOC_BUILDER_STR({
label: "old-faithful",
str: "44.46046°N 110.82815°W",
2023-03-17 11:04:13 +08:00
alt: 2240,
})
, LOC_BUILDER_STR({
label: "ribblehead-viaduct",
str: "54.210436°N 2.370231°W",
2023-03-17 11:04:13 +08:00
alt: 300,
})
, LOC_BUILDER_STR({
label: "guinness-brewery",
str: "53°2040″N 6°1720″W",
2023-03-17 11:04:13 +08:00
alt: 300,
})
);
```
{% endcode %}
Part of the series:
* [`LOC()`](../domain/LOC.md) - build a `LOC` by supplying all 12 parameters
* [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y
* [`LOC_BUILDER_DMS_STR({})`](../record/LOC_BUILDER_DMS_STR.md) - accepts DMS 33°5131″S 151°1251″E
* [`LOC_BUILDER_DMM_STR({})`](../record/LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
* [`LOC_BUILDER_STR({})`](../record/LOC_BUILDER_STR.md) - tries the cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works