Options
All
  • Public
  • Public/Protected
  • All
Menu

spread-the-word

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AddressRecord

AddressRecord: A | AAAA

DataType

DataType: TXTData | Buffer | string

RecordType

RecordType: "TXT" | "A" | "AAAA" | "PTR" | "SRV" | "ANY"

StatusType

StatusType: "uninitialized" | "spreaded" | "destroyed"

Variables

Const REANNOUNCE_FACTOR

REANNOUNCE_FACTOR: 3 = 3

Const REANNOUNCE_MAX_MS

REANNOUNCE_MAX_MS: number = 60 * 60 * 1000

Const REQUERY_FACTOR

REQUERY_FACTOR: 1.5 = 1.5

Const REQUERY_MAX_MS

REQUERY_MAX_MS: number = 60 * 60 * 1000

Const TOP_LEVEL_DOMAIN

TOP_LEVEL_DOMAIN: "local" = "local"

Const WILDCARD

WILDCARD: string = "_services._dns-sd._udp." + TOP_LEVEL_DOMAIN

Const debugLog

debugLog: Debugger = debug("SpreadTheWord:Listener")

Functions

getExternalAddresses

  • getExternalAddresses(): { address: string; family: string }[]

parseDNSName

parseRecord

  • parseRecord(record: any, options?: { binaryTXT?: boolean }): A | TXT | SRV | PTR | AAAA

  • Parameters

    • record: any
    • Default value options: { binaryTXT?: boolean } = {}
      • Optional binaryTXT?: boolean

    Returns A | TXT | SRV | PTR | AAAA

parseTXTData

  • parseTXTData(data: Buffer, options?: { binary?: boolean }): TXTData

  • Parameters

    • data: Buffer
    • Default value options: { binary?: boolean } = { binary: false }
      • Optional binary?: boolean

    Returns TXTData

sameRecord

serializeDNSName

serializeRecord

  • serializeRecord(record: any, options?: { binaryTXT?: boolean }): A | TXT | SRV | PTR | AAAA

  • Parameters

    • record: any
    • Default value options: { binaryTXT?: boolean } = {}
      • Optional binaryTXT?: boolean

    Returns A | TXT | SRV | PTR | AAAA

serializeTXTData

  • serializeTXTData(data: TXTData, options?: { binary?: boolean }): Buffer

  • Parameters

    • data: TXTData
    • Default value options: { binary?: boolean } = { binary: false }
      • Optional binary?: boolean

    Returns Buffer

toPlainObject

  • toPlainObject(instance: any): any