From fe7370b9a6e4bf82eac49f6d0cd38055cf011a71 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Tue, 13 Aug 2024 10:57:31 -0400 Subject: [PATCH] CHORE: go generate (#3079) --- commands/types/dnscontrol.d.ts | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/commands/types/dnscontrol.d.ts b/commands/types/dnscontrol.d.ts index dbaa705ba..c38198d22 100644 --- a/commands/types/dnscontrol.d.ts +++ b/commands/types/dnscontrol.d.ts @@ -2259,7 +2259,26 @@ declare const NO_PURGE: DomainModifier; declare function NS(name: string, target: string, ...modifiers: RecordModifier[]): DomainModifier; /** - * Documentation needed. + * `NS1_URLFWD` is an NS1-specific feature that maps to NS1's URLFWD record, which creates HTTP 301 (permanent) or 302 (temporary) redirects. + * + * ```javascript + * D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), + * NS1_URLFWD("urlfwd", "/ http://example.com 302 2 0") + * ); + * ``` + * + * The fields are: + * * name: the record name + * * target: a complex field containing the following, space separated: + * * from - the path to match + * * to - the url to redirect to + * * redirectType - (0 - masking, 301, 302) + * * pathForwardingMode - (0 - All, 1 - Capture, 2 - None) + * * queryForwardingMode - (0 - disabled, 1 - enabled) + * + * WARNING: According to NS1, this type of record is deprecated and in the process + * of being replaced by the premium-only `REDIRECT` record type. While still able to be + * configured through the API, as suggested by NS1, please try not to use it, going forward. * * @see https://docs.dnscontrol.org/language-reference/domain-modifiers/service-provider-specific/ns1/ns1_urlfwd */