@layered/dns-records
Version:
Discover publicly available DNS Records for a domain
25 lines (24 loc) • 954 B
TypeScript
import { type DnsRecord } from './index.js';
/**
* Get DNS records of a given type for a FQDN.
*
* @param name Fully qualified domain name, like example.com or mail.google.com (no protocol or path)
* @param type DNS record type: A, AAAA, TXT, CNAME, MX, etc.
* @param resolver Which DNS resolver to use. If not specified, the best DNS resolver for this runtime will be used.
* @returns Array of discovered `DnsRecord` objects.
*
* @example Get TXT records for example.com
* ```js
* import { getDnsRecords } from '@layered/dns-records'
*
* const txtRecords = await getDnsRecords('example.com', 'TXT')
* ```
*
* @example Get MX records for android.com from Google DNS resolver
* ```js
* import { getDnsRecords } from '@layered/dns-records'
*
* const mxRecords = await getDnsRecords('android.com', 'MX', 'google-dns')
* ```
*/
export declare function getDnsRecords(name: string, type?: string, resolver?: string): Promise<DnsRecord[]>;