@xyo-network/dns

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

sdk-utils

### packages

  ### dns

    ### .temp-typedoc

      ### functions

        ### <a id="domainExists"></a>domainExists

@xyo-network/dns

function domainExists(domain?): Promise<boolean>;

Checks if a domain exists (resolves using DNS)

Parameters

domain?

string

string

Returns

Promise<boolean>

boolean

        ### <a id="domainResolve"></a>domainResolve

@xyo-network/dns

function domainResolve(domain?, type?): Promise<GoogleDnsResult | undefined>;

Resolves DNS information (resolves using DNS)

Parameters

domain?

string

string

type?

DnsRecordType = DnsRecordType.A

Returns

Promise<GoogleDnsResult | undefined>

GoogleDnsResult

        ### <a id="googleDnsOverHttps"></a>googleDnsOverHttps

@xyo-network/dns

function googleDnsOverHttps(name, type?): Promise<GoogleDnsResult>;

Parameters

name

string

type?

DnsRecordType = DnsRecordType.A

Returns

Promise<GoogleDnsResult>

      ### interfaces

        ### <a id="GoogleDnsResult"></a>GoogleDnsResult

@xyo-network/dns

Properties

AD?

optional AD?: boolean;

Answer?

optional Answer?: GoogleDnsResultAnswer[];

Authority?

optional Authority?: GoogleDnsResultAnswer[];

CD?

optional CD?: boolean;

Comment?

optional Comment?: string;

Question?

optional Question?: GoogleDnsResultQuestion[];

RA?

optional RA?: boolean;

RD?

optional RD?: boolean;

Status?

optional Status?: number;

TC?

optional TC?: boolean;

edns_client_subnet?

optional edns_client_subnet?: string;

        ### <a id="GoogleDnsResultAnswer"></a>GoogleDnsResultAnswer

@xyo-network/dns

Properties

TTL?

optional TTL?: number;

data?

optional data?: string;

name?

optional name?: string;

type?

optional type?: DnsRecordType;

        ### <a id="GoogleDnsResultQuestion"></a>GoogleDnsResultQuestion

@xyo-network/dns

Properties

cd?

optional cd?: boolean;

ct?

optional ct?: string;

do?

optional do?: boolean;

edns_client_subnet?

optional edns_client_subnet?: string;

name?

optional name?: string;

random_padding?

optional random_padding?: string;

type?

optional type?: DnsRecordType;

      ### type-aliases

        ### <a id="DnsRecordType"></a>DnsRecordType

@xyo-network/dns

type DnsRecordType = typeof DnsRecordType[keyof typeof DnsRecordType];

        ### <a id="DnsReturnCode"></a>DnsReturnCode

@xyo-network/dns

type DnsReturnCode = typeof DnsReturnCode[keyof typeof DnsReturnCode];

      ### variables

        ### <a id="DnsRecordType"></a>DnsRecordType

@xyo-network/dns

const DnsRecordType: object;

Type Declaration

A

readonly A: 1 = 1;

AAAA

readonly AAAA: 28 = 28;

CAA

readonly CAA: 257 = 257;

CNAME

readonly CNAME: 5 = 5;

DNAME

readonly DNAME: 39 = 39;

MX

readonly MX: 15 = 15;

NS

readonly NS: 2 = 2;

PTR

readonly PTR: 12 = 12;

SOA

readonly SOA: 6 = 6;

SPF

readonly SPF: 99 = 99;

SRV

readonly SRV: 33 = 33;

TXT

readonly TXT: 16 = 16;

        ### <a id="DnsReturnCode"></a>DnsReturnCode

@xyo-network/dns

const DnsReturnCode: object;

Type Declaration

NoError

NoError: number = 0;

QueryFormatError

QueryFormatError: number = 1;

ServerFailed

ServerFailed: number = 2;

DomainDoesNotExist

DomainDoesNotExist: number = 3;

NotImplemented

NotImplemented: number = 4;

Refused

Refused: number = 5;

NameShouldNotExist

NameShouldNotExist: number = 6;

RRSetShouldNotExist

RRSetShouldNotExist: number = 7;

NotAuthoritative

NotAuthoritative: number = 8;

NotInZone

NotInZone: number = 9;