1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

Fix the return types of *_BUILDER functions (#2583)

Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
Purrrpley
2023-10-09 02:39:18 +11:00
committed by GitHub
parent f661cd4777
commit 7e79713603
8 changed files with 14 additions and 14 deletions

View File

@@ -0,0 +1,56 @@
---
name: LOC_BUILDER_DMS_STR
parameters:
- label
- str
- alt
- ttl
parameters_object: true
parameter_types:
label: string?
str: string
alt: number?
ttl: Duration?
---
`LOC_BUILDER_DMS_STR({})` 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`](../domain/LOC.md) records. Supply three parameters instead of 12.
Internally assumes some defaults for [`LOC`](../domain/LOC.md) records.
Accepts a string with degrees, minutes, and seconds (DMS) coordinates in the form: 41°24'12.2"N 2°10'26.5"E
Note that the following are acceptable forms (symbols differ):
* `33°5131″S 151°1251″E`
* `33°51'31"S 151°12'51"E`
* `33d51m31sS 151d12m51sE`
* `33d51m31s S 151d12m51s E`
{% code title="dnsconfig.js" %}
```javascript
D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
LOC_BUILDER_DMS_STR({
label: "sydney-opera-house",
str: "33°5131″S 151°1251″E",
alt: 4,
ttl: "5m",
})
);
```
{% 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