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:
49
commands/types/dnscontrol.d.ts
vendored
49
commands/types/dnscontrol.d.ts
vendored
@ -685,6 +685,23 @@ declare function IGNORE_TARGET(pattern: string, rType: string): DomainModifier;
|
|||||||
declare function INCLUDE(domain: string): DomainModifier;
|
declare function INCLUDE(domain: string): DomainModifier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* 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 ##
|
* ## Description ##
|
||||||
*
|
*
|
||||||
* Strictly follows [RFC 1876](https://datatracker.ietf.org/doc/html/rfc1876).
|
* Strictly follows [RFC 1876](https://datatracker.ietf.org/doc/html/rfc1876).
|
||||||
@ -757,7 +774,7 @@ declare function INCLUDE(domain: string): DomainModifier;
|
|||||||
*
|
*
|
||||||
* @see https://dnscontrol.org/js#LOC
|
* @see https://dnscontrol.org/js#LOC
|
||||||
*/
|
*/
|
||||||
declare function LOC(deg1: uint32, min1: uint32, sec1: float32, deg2: uint32, min2: uint32, sec2: float32, altitude: uint32, size: float32, horizontal_precision: float32, vertical_precision: float32): DomainModifier;
|
declare function LOC(deg1: number, min1: number, sec1: number, deg2: number, min2: number, sec2: number, altitude: number, size: number, horizontal_precision: number, vertical_precision: number): DomainModifier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* MX adds an MX record to the domain.
|
* MX adds an MX record to the domain.
|
||||||
@ -2203,9 +2220,9 @@ declare function DMARC_BUILDER(opts: { label?: string; version?: string; policy:
|
|||||||
* `LOC_BUILDER_DD({})` actually takes an object with the following properties:
|
* `LOC_BUILDER_DD({})` actually takes an object with the following properties:
|
||||||
*
|
*
|
||||||
* - label (optional, defaults to `@`)
|
* - label (optional, defaults to `@`)
|
||||||
* - x
|
* - x (float32)
|
||||||
* - y
|
* - y (float32)
|
||||||
* - alt
|
* - alt (float32, optional)
|
||||||
* - ttl (optional)
|
* - ttl (optional)
|
||||||
*
|
*
|
||||||
* A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12.
|
* A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12.
|
||||||
@ -2256,14 +2273,14 @@ declare function DMARC_BUILDER(opts: { label?: string; version?: string; policy:
|
|||||||
*
|
*
|
||||||
* @see https://dnscontrol.org/js#LOC_BUILDER_DD
|
* @see https://dnscontrol.org/js#LOC_BUILDER_DD
|
||||||
*/
|
*/
|
||||||
declare function LOC_BUILDER_DD(label: string, x: float32, y: float32, alt: float32, ttl: int): RecordModifier;
|
declare function LOC_BUILDER_DD(opts: { label?: string; x: number; y: number; alt?: number; ttl?: Duration }): RecordModifier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* `LOC_BUILDER_DMM({})` actually takes an object with the following properties:
|
* `LOC_BUILDER_DMM({})` actually takes an object with the following properties:
|
||||||
*
|
*
|
||||||
* - label (optional, defaults to `@`)
|
* - label (string, optional, defaults to `@`)
|
||||||
* - str
|
* - str (string)
|
||||||
* - alt
|
* - alt (float32, optional)
|
||||||
* - ttl (optional)
|
* - ttl (optional)
|
||||||
*
|
*
|
||||||
* A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
* A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||||
@ -2298,14 +2315,14 @@ declare function LOC_BUILDER_DD(label: string, x: float32, y: float32, alt: floa
|
|||||||
*
|
*
|
||||||
* @see https://dnscontrol.org/js#LOC_BUILDER_DMM_STR
|
* @see https://dnscontrol.org/js#LOC_BUILDER_DMM_STR
|
||||||
*/
|
*/
|
||||||
declare function LOC_BUILDER_DMM_STR(label: string, str: string, alt: float32, ttl: int): RecordModifier;
|
declare function LOC_BUILDER_DMM_STR(opts: { label?: string; str: string; alt?: number; ttl?: Duration }): RecordModifier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* `LOC_BUILDER_DMS_STR({})` actually takes an object with the following properties:
|
* `LOC_BUILDER_DMS_STR({})` actually takes an object with the following properties:
|
||||||
*
|
*
|
||||||
* - label (optional, defaults to `@`)
|
* - label (string, optional, defaults to `@`)
|
||||||
* - str
|
* - str (string)
|
||||||
* - alt
|
* - alt (float32, optional)
|
||||||
* - ttl (optional)
|
* - ttl (optional)
|
||||||
*
|
*
|
||||||
* A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
* A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||||
@ -2341,14 +2358,14 @@ declare function LOC_BUILDER_DMM_STR(label: string, str: string, alt: float32, t
|
|||||||
*
|
*
|
||||||
* @see https://dnscontrol.org/js#LOC_BUILDER_DMS_STR
|
* @see https://dnscontrol.org/js#LOC_BUILDER_DMS_STR
|
||||||
*/
|
*/
|
||||||
declare function LOC_BUILDER_DMS_STR(label: string, str: string, alt: float32, ttl: int): RecordModifier;
|
declare function LOC_BUILDER_DMS_STR(opts: { label?: string; str: string; alt?: number; ttl?: Duration }): RecordModifier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* `LOC_BUILDER_STR({})` actually takes an object with the following: properties.
|
* `LOC_BUILDER_STR({})` actually takes an object with the following: properties.
|
||||||
*
|
*
|
||||||
* - label (optional, defaults to `@`)
|
* - label (optional, defaults to `@`)
|
||||||
* - str
|
* - str (string)
|
||||||
* - alt
|
* - alt (float32, optional)
|
||||||
* - ttl (optional)
|
* - ttl (optional)
|
||||||
*
|
*
|
||||||
* A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
* A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||||
@ -2389,7 +2406,7 @@ declare function LOC_BUILDER_DMS_STR(label: string, str: string, alt: float32, t
|
|||||||
*
|
*
|
||||||
* @see https://dnscontrol.org/js#LOC_BUILDER_STR
|
* @see https://dnscontrol.org/js#LOC_BUILDER_STR
|
||||||
*/
|
*/
|
||||||
declare function LOC_BUILDER_STR(label: string, str: string, alt: float32, ttl: int): RecordModifier;
|
declare function LOC_BUILDER_STR(opts: { label?: string; str: string; alt?: number; ttl?: Duration }): RecordModifier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* R53_ZONE lets you specify the AWS Zone ID for an entire domain (D()) or a specific R53_ALIAS() record.
|
* R53_ZONE lets you specify the AWS Zone ID for an entire domain (D()) or a specific R53_ALIAS() record.
|
||||||
|
@ -14,18 +14,36 @@ parameters:
|
|||||||
parameter_types:
|
parameter_types:
|
||||||
name: string
|
name: string
|
||||||
target: string
|
target: string
|
||||||
deg1: uint32
|
deg1: number
|
||||||
min1: uint32
|
min1: number
|
||||||
sec1: float32
|
sec1: number
|
||||||
deg2: uint32
|
deg2: number
|
||||||
min2: uint32
|
min2: number
|
||||||
sec2: float32
|
sec2: number
|
||||||
altitude: uint32
|
altitude: number
|
||||||
size: float32
|
size: number
|
||||||
horizontal_precision: float32
|
horizontal_precision: number
|
||||||
vertical_precision: float32
|
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 ##
|
## Description ##
|
||||||
|
|
||||||
Strictly follows [RFC 1876](https://datatracker.ietf.org/doc/html/rfc1876).
|
Strictly follows [RFC 1876](https://datatracker.ietf.org/doc/html/rfc1876).
|
||||||
|
@ -6,20 +6,21 @@ parameters:
|
|||||||
- y
|
- y
|
||||||
- alt
|
- alt
|
||||||
- ttl
|
- ttl
|
||||||
|
parameters_object: true
|
||||||
parameter_types:
|
parameter_types:
|
||||||
label: string
|
label: string?
|
||||||
x: float32
|
x: number
|
||||||
y: float32
|
y: number
|
||||||
alt: float32
|
alt: number?
|
||||||
ttl: int
|
ttl: Duration?
|
||||||
---
|
---
|
||||||
|
|
||||||
`LOC_BUILDER_DD({})` actually takes an object with the following properties:
|
`LOC_BUILDER_DD({})` actually takes an object with the following properties:
|
||||||
|
|
||||||
- label (optional, defaults to `@`)
|
- label (optional, defaults to `@`)
|
||||||
- x
|
- x (float32)
|
||||||
- y
|
- y (float32)
|
||||||
- alt
|
- alt (float32, optional)
|
||||||
- ttl (optional)
|
- ttl (optional)
|
||||||
|
|
||||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12.
|
A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12.
|
||||||
|
@ -5,18 +5,19 @@ parameters:
|
|||||||
- str
|
- str
|
||||||
- alt
|
- alt
|
||||||
- ttl
|
- ttl
|
||||||
|
parameters_object: true
|
||||||
parameter_types:
|
parameter_types:
|
||||||
label: string
|
label: string?
|
||||||
str: string
|
str: string
|
||||||
alt: float32
|
alt: number?
|
||||||
ttl: int
|
ttl: Duration?
|
||||||
---
|
---
|
||||||
|
|
||||||
`LOC_BUILDER_DMM({})` actually takes an object with the following properties:
|
`LOC_BUILDER_DMM({})` actually takes an object with the following properties:
|
||||||
|
|
||||||
- label (optional, defaults to `@`)
|
- label (string, optional, defaults to `@`)
|
||||||
- str
|
- str (string)
|
||||||
- alt
|
- alt (float32, optional)
|
||||||
- ttl (optional)
|
- ttl (optional)
|
||||||
|
|
||||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||||
|
@ -5,18 +5,19 @@ parameters:
|
|||||||
- str
|
- str
|
||||||
- alt
|
- alt
|
||||||
- ttl
|
- ttl
|
||||||
|
parameters_object: true
|
||||||
parameter_types:
|
parameter_types:
|
||||||
label: string
|
label: string?
|
||||||
str: string
|
str: string
|
||||||
alt: float32
|
alt: number?
|
||||||
ttl: int
|
ttl: Duration?
|
||||||
---
|
---
|
||||||
|
|
||||||
`LOC_BUILDER_DMS_STR({})` actually takes an object with the following properties:
|
`LOC_BUILDER_DMS_STR({})` actually takes an object with the following properties:
|
||||||
|
|
||||||
- label (optional, defaults to `@`)
|
- label (string, optional, defaults to `@`)
|
||||||
- str
|
- str (string)
|
||||||
- alt
|
- alt (float32, optional)
|
||||||
- ttl (optional)
|
- ttl (optional)
|
||||||
|
|
||||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||||
|
@ -5,18 +5,19 @@ parameters:
|
|||||||
- str
|
- str
|
||||||
- alt
|
- alt
|
||||||
- ttl
|
- ttl
|
||||||
|
parameters_object: true
|
||||||
parameter_types:
|
parameter_types:
|
||||||
label: string
|
label: string?
|
||||||
str: string
|
str: string
|
||||||
alt: float32
|
alt: number?
|
||||||
ttl: int
|
ttl: Duration?
|
||||||
---
|
---
|
||||||
|
|
||||||
`LOC_BUILDER_STR({})` actually takes an object with the following: properties.
|
`LOC_BUILDER_STR({})` actually takes an object with the following: properties.
|
||||||
|
|
||||||
- label (optional, defaults to `@`)
|
- label (optional, defaults to `@`)
|
||||||
- str
|
- str (string)
|
||||||
- alt
|
- alt (float32, optional)
|
||||||
- ttl (optional)
|
- ttl (optional)
|
||||||
|
|
||||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||||
|
Reference in New Issue
Block a user