@types/dns-packet

  • Version 5.2.4
  • Published
  • 8.77 kB
  • 1 dependency
  • MIT license

Install

npm i @types/dns-packet
yarn add @types/dns-packet
pnpm add @types/dns-packet

Overview

TypeScript definitions for dns-packet

Index

Variables

variable AUTHENTIC_DATA

const AUTHENTIC_DATA: number;

    variable AUTHORITATIVE_ANSWER

    const AUTHORITATIVE_ANSWER: number;

      variable CHECKING_DISABLED

      const CHECKING_DISABLED: number;

        variable RECURSION_AVAILABLE

        const RECURSION_AVAILABLE: number;

          variable RECURSION_DESIRED

          const RECURSION_DESIRED: number;

            variable TRUNCATED_RESPONSE

            const TRUNCATED_RESPONSE: number;

              Functions

              function decode

              decode: typeof decode;

                function encode

                encode: typeof encode;

                  function encodingLength

                  encodingLength: (packet: Packet) => number;

                    function streamDecode

                    streamDecode: typeof streamDecode;

                      function streamEncode

                      streamEncode: typeof streamEncode;

                        Interfaces

                        interface BaseAnswer

                        interface BaseAnswer<T, D> extends GenericAnswer<T> {}

                          property class

                          class?: RecordClass | undefined;

                            property data

                            data: D;

                              property flush

                              flush?: boolean | undefined;

                                property ttl

                                ttl?: number | undefined;

                                  interface CaaData

                                  interface CaaData {}

                                    property flags

                                    flags?: number | undefined;

                                      property issuerCritical

                                      issuerCritical?: boolean | undefined;

                                        property tag

                                        tag: string;

                                          property value

                                          value: string;

                                            interface GenericAnswer

                                            interface GenericAnswer<T> {}

                                              property name

                                              name: string;

                                                property type

                                                type: T;

                                                  interface HInfoData

                                                  interface HInfoData {}

                                                    property cpu

                                                    cpu: string;

                                                      property os

                                                      os: string;

                                                        interface MxData

                                                        interface MxData {}

                                                          property exchange

                                                          exchange: string;

                                                            property preference

                                                            preference?: number | undefined;

                                                              interface OptAnswer

                                                              interface OptAnswer extends GenericAnswer<'OPT'> {}

                                                                property ednsVersion

                                                                ednsVersion: number;

                                                                  property extendedRcode

                                                                  extendedRcode: number;

                                                                    property flag_do

                                                                    flag_do: boolean;
                                                                    • Whether or not the DNS DO bit is set

                                                                    property flags

                                                                    flags: number;

                                                                      property options

                                                                      options: PacketOpt[];

                                                                        property udpPayloadSize

                                                                        udpPayloadSize: number;

                                                                          interface Packet

                                                                          interface Packet {}

                                                                            property additionals

                                                                            additionals?: Answer[] | undefined;

                                                                              property answers

                                                                              answers?: Answer[] | undefined;

                                                                                property authorities

                                                                                authorities?: Answer[] | undefined;

                                                                                  property flags

                                                                                  flags?: number | undefined;

                                                                                  property id

                                                                                  id?: number | undefined;

                                                                                    property questions

                                                                                    questions?: Question[] | undefined;

                                                                                      property type

                                                                                      type?: 'query' | 'response' | undefined;
                                                                                      • Whether the packet is a query or a response. This field may be omitted if it is clear from the context of usage what type of packet it is.

                                                                                      interface Question

                                                                                      interface Question {}

                                                                                        property class

                                                                                        class?: RecordClass | undefined;

                                                                                          property name

                                                                                          name: string;

                                                                                            property type

                                                                                            type: RecordType;

                                                                                              interface SoaData

                                                                                              interface SoaData {}

                                                                                                property expire

                                                                                                expire?: number | undefined;

                                                                                                  property minimum

                                                                                                  minimum?: number | undefined;

                                                                                                    property mname

                                                                                                    mname: string;

                                                                                                      property refresh

                                                                                                      refresh?: number | undefined;

                                                                                                        property retry

                                                                                                        retry?: number | undefined;

                                                                                                          property rname

                                                                                                          rname: string;

                                                                                                            property serial

                                                                                                            serial?: number | undefined;

                                                                                                              interface SrvData

                                                                                                              interface SrvData {}

                                                                                                                property port

                                                                                                                port: number;

                                                                                                                  property priority

                                                                                                                  priority?: number | undefined;

                                                                                                                    property target

                                                                                                                    target: string;

                                                                                                                      property weight

                                                                                                                      weight?: number | undefined;

                                                                                                                        Type Aliases

                                                                                                                        type Answer

                                                                                                                        type Answer =
                                                                                                                        | StringAnswer
                                                                                                                        | SrvAnswer
                                                                                                                        | HInfoAnswer
                                                                                                                        | SoaAnswer
                                                                                                                        | TxtAnswer
                                                                                                                        | CaaAnswer
                                                                                                                        | MxAnswer
                                                                                                                        | BufferAnswer
                                                                                                                        | OptAnswer;

                                                                                                                          type BufferAnswer

                                                                                                                          type BufferAnswer = BaseAnswer<OtherRecordType, Buffer>;

                                                                                                                            type CaaAnswer

                                                                                                                            type CaaAnswer = BaseAnswer<'CAA', CaaData>;

                                                                                                                              type HInfoAnswer

                                                                                                                              type HInfoAnswer = BaseAnswer<'HINFO', HInfoData>;

                                                                                                                                type MxAnswer

                                                                                                                                type MxAnswer = BaseAnswer<'MX', MxData>;

                                                                                                                                  type OtherRecordType

                                                                                                                                  type OtherRecordType =
                                                                                                                                  | 'AFSDB'
                                                                                                                                  | 'APL'
                                                                                                                                  | 'AXFR'
                                                                                                                                  | 'CDNSKEY'
                                                                                                                                  | 'CDS'
                                                                                                                                  | 'CERT'
                                                                                                                                  | 'DHCID'
                                                                                                                                  | 'DLV'
                                                                                                                                  | 'DNSKEY'
                                                                                                                                  | 'DS'
                                                                                                                                  | 'HIP'
                                                                                                                                  | 'IXFR'
                                                                                                                                  | 'IPSECKEY'
                                                                                                                                  | 'KEY'
                                                                                                                                  | 'KX'
                                                                                                                                  | 'LOC'
                                                                                                                                  | 'NAPTR'
                                                                                                                                  | 'NSEC'
                                                                                                                                  | 'NSEC3'
                                                                                                                                  | 'NSEC3PARAM'
                                                                                                                                  | 'NULL'
                                                                                                                                  | 'RRSIG'
                                                                                                                                  | 'RP'
                                                                                                                                  | 'SIG'
                                                                                                                                  | 'SSHFP'
                                                                                                                                  | 'TA'
                                                                                                                                  | 'TKEY'
                                                                                                                                  | 'TLSA'
                                                                                                                                  | 'TSIG'
                                                                                                                                  | 'URI';
                                                                                                                                  • Record types for which the library does not attempt to process the data field.

                                                                                                                                  type PacketOpt

                                                                                                                                  type PacketOpt = ClientSubnetOpt | KeepAliveOpt | PaddingOpt | TagOpt;

                                                                                                                                    type RecordClass

                                                                                                                                    type RecordClass = 'IN' | 'CS' | 'CH' | 'HS' | 'ANY';

                                                                                                                                      type RecordType

                                                                                                                                      type RecordType =
                                                                                                                                      | 'A'
                                                                                                                                      | 'AAAA'
                                                                                                                                      | 'AFSDB'
                                                                                                                                      | 'APL'
                                                                                                                                      | 'AXFR'
                                                                                                                                      | 'CAA'
                                                                                                                                      | 'CDNSKEY'
                                                                                                                                      | 'CDS'
                                                                                                                                      | 'CERT'
                                                                                                                                      | 'CNAME'
                                                                                                                                      | 'DNAME'
                                                                                                                                      | 'DHCID'
                                                                                                                                      | 'DLV'
                                                                                                                                      | 'DNSKEY'
                                                                                                                                      | 'DS'
                                                                                                                                      | 'HINFO'
                                                                                                                                      | 'HIP'
                                                                                                                                      | 'IXFR'
                                                                                                                                      | 'IPSECKEY'
                                                                                                                                      | 'KEY'
                                                                                                                                      | 'KX'
                                                                                                                                      | 'LOC'
                                                                                                                                      | 'MX'
                                                                                                                                      | 'NAPTR'
                                                                                                                                      | 'NS'
                                                                                                                                      | 'NSEC'
                                                                                                                                      | 'NSEC3'
                                                                                                                                      | 'NSEC3PARAM'
                                                                                                                                      | 'NULL'
                                                                                                                                      | 'OPT'
                                                                                                                                      | 'PTR'
                                                                                                                                      | 'RRSIG'
                                                                                                                                      | 'RP'
                                                                                                                                      | 'SIG'
                                                                                                                                      | 'SOA'
                                                                                                                                      | 'SRV'
                                                                                                                                      | 'SSHFP'
                                                                                                                                      | 'TA'
                                                                                                                                      | 'TKEY'
                                                                                                                                      | 'TLSA'
                                                                                                                                      | 'TSIG'
                                                                                                                                      | 'TXT'
                                                                                                                                      | 'URI';
                                                                                                                                      • The currently defined set of DNS record types.

                                                                                                                                      type SoaAnswer

                                                                                                                                      type SoaAnswer = BaseAnswer<'SOA', SoaData>;

                                                                                                                                        type SrvAnswer

                                                                                                                                        type SrvAnswer = BaseAnswer<'SRV', SrvData>;

                                                                                                                                          type StringAnswer

                                                                                                                                          type StringAnswer = BaseAnswer<StringRecordType, string>;

                                                                                                                                            type StringRecordType

                                                                                                                                            type StringRecordType = 'A' | 'AAAA' | 'CNAME' | 'DNAME' | 'NS' | 'PTR';
                                                                                                                                            • Record types for which the library will provide a string in the data field.

                                                                                                                                            type TxtAnswer

                                                                                                                                            type TxtAnswer = BaseAnswer<'TXT', TxtData>;

                                                                                                                                              type TxtData

                                                                                                                                              type TxtData = string | Buffer | Array<string | Buffer>;

                                                                                                                                                Namespaces

                                                                                                                                                namespace decode

                                                                                                                                                namespace decode {}

                                                                                                                                                  variable bytes

                                                                                                                                                  let bytes: number;

                                                                                                                                                    namespace encode

                                                                                                                                                    namespace encode {}

                                                                                                                                                      variable bytes

                                                                                                                                                      let bytes: number;

                                                                                                                                                        namespace streamDecode

                                                                                                                                                        namespace streamDecode {}

                                                                                                                                                          variable bytes

                                                                                                                                                          let bytes: number;

                                                                                                                                                            namespace streamEncode

                                                                                                                                                            namespace streamEncode {}

                                                                                                                                                              variable bytes

                                                                                                                                                              let bytes: number;

                                                                                                                                                                Package Files (1)

                                                                                                                                                                Dependencies (1)

                                                                                                                                                                Dev Dependencies (0)

                                                                                                                                                                No dev dependencies.

                                                                                                                                                                Peer Dependencies (0)

                                                                                                                                                                No peer dependencies.

                                                                                                                                                                Badge

                                                                                                                                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/dns-packet.

                                                                                                                                                                • Markdown
                                                                                                                                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/dns-packet)
                                                                                                                                                                • HTML
                                                                                                                                                                  <a href="https://www.jsdocs.io/package/@types/dns-packet"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>