mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2025-09-09 14:46:40 +08:00
62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
---
|
||
name: LOC_BUILDER_STR
|
||
parameters:
|
||
- label
|
||
- str
|
||
- alt
|
||
- ttl
|
||
parameters_object: true
|
||
parameter_types:
|
||
label: string?
|
||
str: string
|
||
alt: number?
|
||
ttl: 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`](LOC.md) records. Supply three parameters instead of 12.
|
||
|
||
Internally assumes some defaults for [`LOC`](LOC.md) records.
|
||
|
||
|
||
Accepts a string and tries all `LOC_BUILDER_DM*_STR({})` methods:
|
||
* [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E
|
||
* [`LOC_BUILDER_DMM_STR({})`](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),
|
||
, 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°20′40″N 6°17′20″W",
|
||
alt: 300,
|
||
})
|
||
);
|
||
|
||
```
|
||
{% 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°51′31″S 151°12′51″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 cooordinate string in all `LOC_BUILDER_DM*_STR()` functions until one works
|