Function resolve

Resolves a DNS name in a single call, opening and closing a connection around one query.

The return type narrows on the requested TYPE (see ResolveResult); A addresses come back as string[], MX as MxRecord[], and so on. NXDOMAIN and "no records" both yield an empty array (never a throw); a server error rcode (SERVFAIL, REFUSED, ...) throws a ProtocolError. Pass server to choose the resolver - inside a Worker this must be a non-Cloudflare resolver such as RESOLVERS.google, because the 1.1.1.1 default is blocked by the runtime.

Param: name

The domain name to resolve.

Param: typeOrOpts

A record TYPE (name or number) or a ResolveOptions object.

Returns

The resolved records, typed per the TYPE.

Throws

On a server error rcode or a malformed response.

Throws

If the resolver cannot be reached.

Throws

If the query deadline elapses.

Since

1.0.4

Example

import { resolve, RESOLVERS } from 'edgeport/dns';

const a = await resolve('example.com', 'A'); // string[]
const mx = await resolve('example.com', 'MX'); // MxRecord[]
const aaaa = await resolve('example.com', { type: 'AAAA', server: RESOLVERS.google });

resolve(name: string): Promise<string[]>
Resolves a name to A records (the default type): the IPv4 addresses as strings.
Parameters
- name: string
  The domain name.
Returns Promise<string[]>
The IPv4 addresses; empty on NXDOMAIN or no records.
- Defined in src/dns/index.ts:694
resolve(
name: string,
type: "A" | "NS" | "CNAME" | "PTR" | "AAAA",
): Promise<string[]>
Resolves a name to a string array (A/AAAA/NS/CNAME/PTR).
Parameters
- name: string
- type: "A" | "NS" | "CNAME" | "PTR" | "AAAA"
Returns Promise<string[]>
- Defined in src/dns/index.ts:696
resolve(name: string, type: "TXT"): Promise<string[][]>
Resolves TXT records (each an array of its character-strings).
Parameters
- name: string
- type: "TXT"
Returns Promise<string[][]>
- Defined in src/dns/index.ts:701
resolve(name: string, type: "MX"): Promise<MxRecord[]>
Resolves MX records.
Parameters
- name: string
- type: "MX"
Returns Promise<MxRecord[]>
- Defined in src/dns/index.ts:703
resolve(name: string, type: "SRV"): Promise<SrvRecord[]>
Resolves SRV records.
Parameters
- name: string
- type: "SRV"
Returns Promise<SrvRecord[]>
- Defined in src/dns/index.ts:705
resolve(name: string, type: "CAA"): Promise<CaaRecord[]>
Resolves CAA records.
Parameters
- name: string
- type: "CAA"
Returns Promise<CaaRecord[]>
- Defined in src/dns/index.ts:707
resolve(name: string, type: "SOA"): Promise<SoaRecord | undefined>
Resolves the SOA record (or undefined).
Parameters
- name: string
- type: "SOA"
Returns Promise<SoaRecord | undefined>
- Defined in src/dns/index.ts:709
resolve(name: string, type: "NAPTR"): Promise<NaptrRecord[]>
Resolves NAPTR records.
Parameters
- name: string
- type: "NAPTR"
Returns Promise<NaptrRecord[]>
- Defined in src/dns/index.ts:711
resolve(name: string, type: "SSHFP"): Promise<SshfpRecord[]>
Resolves SSHFP records.
Parameters
- name: string
- type: "SSHFP"
Returns Promise<SshfpRecord[]>
- Defined in src/dns/index.ts:713
resolve(name: string, type: "DS"): Promise<DsRecord[]>
Resolves DS records.
Parameters
- name: string
- type: "DS"
Returns Promise<DsRecord[]>
- Defined in src/dns/index.ts:715
resolve(name: string, type: "DNSKEY"): Promise<DnskeyRecord[]>
Resolves DNSKEY records.
Parameters
- name: string
- type: "DNSKEY"
Returns Promise<DnskeyRecord[]>
- Defined in src/dns/index.ts:717
resolve(name: string, type: "TLSA"): Promise<TlsaRecord[]>
Resolves TLSA records.
Parameters
- name: string
- type: "TLSA"
Returns Promise<TlsaRecord[]>
- Defined in src/dns/index.ts:719
resolve(name: string, type: "SVCB" | "HTTPS"): Promise<SvcbRecord[]>
Resolves HTTPS or SVCB service-binding records.
Parameters
- name: string
- type: "SVCB" | "HTTPS"
Returns Promise<SvcbRecord[]>
- Defined in src/dns/index.ts:721
resolve(name: string, type: "RRSIG"): Promise<RrsigRecord[]>
Resolves RRSIG records.
Parameters
- name: string
- type: "RRSIG"
Returns Promise<RrsigRecord[]>
- Defined in src/dns/index.ts:723
resolve<
    T extends
        | "A"
        | "NS"
        | "CNAME"
        | "SOA"
        | "PTR"
        | "MX"
        | "TXT"
        | "AAAA"
        | "SRV"
        | "NAPTR"
        | "OPT"
        | "DS"
        | "SSHFP"
        | "RRSIG"
        | "NSEC"
        | "DNSKEY"
        | "TLSA"
        | "SVCB"
        | "HTTPS"
        | "CAA"
        | "ANY",
>(
    name: string,
    opts: ResolveOptions & { type: T },
): Promise<ResolveResult<T>>
Resolves the type named in opts.type (with resolver/tls/dnssec options).
Type Parameters
- T extends
      | "A"
      | "NS"
      | "CNAME"
      | "SOA"
      | "PTR"
      | "MX"
      | "TXT"
      | "AAAA"
      | "SRV"
      | "NAPTR"
      | "OPT"
      | "DS"
      | "SSHFP"
      | "RRSIG"
      | "NSEC"
      | "DNSKEY"
      | "TLSA"
      | "SVCB"
      | "HTTPS"
      | "CAA"
      | "ANY"
Parameters
- name: string
- opts: ResolveOptions & { type: T }
Returns Promise<ResolveResult<T>>
- Defined in src/dns/index.ts:725
resolve(name: string, opts: ResolveOptions): Promise<ResourceRecord[]>
Resolves with options; a numeric or omitted TYPE yields raw records.
Parameters
- name: string
- opts: ResolveOptions
Returns Promise<ResourceRecord[]>
- Defined in src/dns/index.ts:730
resolve(name: string, type: number): Promise<ResourceRecord[]>
Resolves a numeric record TYPE to its raw records.
Parameters
- name: string
- type: number
Returns Promise<ResourceRecord[]>
- Defined in src/dns/index.ts:732

Function resolve

Param: name

Param: typeOrOpts

Returns

Throws

Throws

Throws

Since

Example

Parameters

Returns Promise<string[]>

Parameters

Returns Promise<string[]>

Parameters

Returns Promise<string[][]>

Parameters

Returns Promise<MxRecord[]>

Parameters

Returns Promise<SrvRecord[]>

Parameters

Returns Promise<CaaRecord[]>

Parameters

Returns Promise<SoaRecord | undefined>

Parameters

Returns Promise<NaptrRecord[]>

Parameters

Returns Promise<SshfpRecord[]>

Parameters

Returns Promise<DsRecord[]>

Parameters

Returns Promise<DnskeyRecord[]>

Parameters

Returns Promise<TlsaRecord[]>

Parameters

Returns Promise<SvcbRecord[]>

Parameters

Returns Promise<RrsigRecord[]>

Type Parameters

Parameters

Returns Promise<ResolveResult<T>>

Parameters

Returns Promise<ResourceRecord[]>

Parameters

Returns Promise<ResourceRecord[]>

Settings