mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
DOCS: Fix number type in typescript (#2219)
This commit is contained in:
@ -14,18 +14,36 @@ parameters:
|
||||
parameter_types:
|
||||
name: string
|
||||
target: string
|
||||
deg1: uint32
|
||||
min1: uint32
|
||||
sec1: float32
|
||||
deg2: uint32
|
||||
min2: uint32
|
||||
sec2: float32
|
||||
altitude: uint32
|
||||
size: float32
|
||||
horizontal_precision: float32
|
||||
vertical_precision: float32
|
||||
deg1: number
|
||||
min1: number
|
||||
sec1: number
|
||||
deg2: number
|
||||
min2: number
|
||||
sec2: number
|
||||
altitude: number
|
||||
size: number
|
||||
horizontal_precision: number
|
||||
vertical_precision: number
|
||||
---
|
||||
|
||||
The parameter number types are as follows:
|
||||
|
||||
```
|
||||
name: string
|
||||
target: string
|
||||
deg1: uint32
|
||||
min1: uint32
|
||||
sec1: float32
|
||||
deg2: uint32
|
||||
min2: uint32
|
||||
sec2: float32
|
||||
altitude: uint32
|
||||
size: float32
|
||||
horizontal_precision: float32
|
||||
vertical_precision: float32
|
||||
```
|
||||
|
||||
|
||||
## Description ##
|
||||
|
||||
Strictly follows [RFC 1876](https://datatracker.ietf.org/doc/html/rfc1876).
|
||||
|
@ -6,20 +6,21 @@ parameters:
|
||||
- y
|
||||
- alt
|
||||
- ttl
|
||||
parameters_object: true
|
||||
parameter_types:
|
||||
label: string
|
||||
x: float32
|
||||
y: float32
|
||||
alt: float32
|
||||
ttl: int
|
||||
label: string?
|
||||
x: number
|
||||
y: number
|
||||
alt: number?
|
||||
ttl: Duration?
|
||||
---
|
||||
|
||||
`LOC_BUILDER_DD({})` actually takes an object with the following properties:
|
||||
|
||||
- label (optional, defaults to `@`)
|
||||
- x
|
||||
- y
|
||||
- alt
|
||||
- x (float32)
|
||||
- y (float32)
|
||||
- alt (float32, optional)
|
||||
- ttl (optional)
|
||||
|
||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12.
|
||||
|
@ -5,18 +5,19 @@ parameters:
|
||||
- str
|
||||
- alt
|
||||
- ttl
|
||||
parameters_object: true
|
||||
parameter_types:
|
||||
label: string
|
||||
label: string?
|
||||
str: string
|
||||
alt: float32
|
||||
ttl: int
|
||||
alt: number?
|
||||
ttl: Duration?
|
||||
---
|
||||
|
||||
`LOC_BUILDER_DMM({})` actually takes an object with the following properties:
|
||||
|
||||
- label (optional, defaults to `@`)
|
||||
- str
|
||||
- alt
|
||||
- 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.
|
||||
|
@ -5,18 +5,19 @@ parameters:
|
||||
- str
|
||||
- alt
|
||||
- ttl
|
||||
parameters_object: true
|
||||
parameter_types:
|
||||
label: string
|
||||
label: string?
|
||||
str: string
|
||||
alt: float32
|
||||
ttl: int
|
||||
alt: number?
|
||||
ttl: Duration?
|
||||
---
|
||||
|
||||
`LOC_BUILDER_DMS_STR({})` actually takes an object with the following properties:
|
||||
|
||||
- label (optional, defaults to `@`)
|
||||
- str
|
||||
- alt
|
||||
- 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.
|
||||
|
@ -5,18 +5,19 @@ parameters:
|
||||
- str
|
||||
- alt
|
||||
- ttl
|
||||
parameters_object: true
|
||||
parameter_types:
|
||||
label: string
|
||||
label: string?
|
||||
str: string
|
||||
alt: float32
|
||||
ttl: int
|
||||
alt: number?
|
||||
ttl: Duration?
|
||||
---
|
||||
|
||||
`LOC_BUILDER_STR({})` actually takes an object with the following: properties.
|
||||
|
||||
- label (optional, defaults to `@`)
|
||||
- str
|
||||
- alt
|
||||
- str (string)
|
||||
- alt (float32, optional)
|
||||
- ttl (optional)
|
||||
|
||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||
|
Reference in New Issue
Block a user