Trait/Object

io.scalajs.nodejs.dns

DNS

Related Docs: object DNS | package dns

Permalink

trait DNS extends Object

The dns module contains functions belonging to two different categories: 1) Functions that use the underlying operating system facilities to perform name resolution, and that do not necessarily perform any network communication. This category contains only one function: dns.lookup(). Developers looking to perform name resolution in the same way that other applications on the same operating system behave should use dns.lookup().

Annotations
@RawJSType() @native()
See also

https://nodejs.org/api/dns.html

Linear Supertypes
Object, Any, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DNS
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getServers(): Array[String]

    Permalink

    Returns an array of IP address strings that are being used for name resolution.

  11. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  15. def lookup(hostname: String, callback: DnsCallback1[String]): Unit

    Permalink

    Resolves a hostname (e.g.

    Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or AAAA (IPv6) record. options can be an object or integer. If options is not provided, then IPv4 and IPv6 addresses are both valid. If options is an integer, then it must be 4 or 6.

    Alternatively, options can be an object containing these properties:

    • family <Number> - The record family. If present, must be the integer 4 or 6. If not provided, both IP v4 and v6 addresses are accepted.
    • hints: <Number> - If present, it should be one or more of the supported getaddrinfo flags. If hints is not provided, then no flags are passed to getaddrinfo. Multiple flags can be passed through hints by logically ORing their values. See supported getaddrinfo flags for more information on supported flags.
    • all: <Boolean> - When true, the callback returns all resolved addresses in an array, otherwise returns a single address. Defaults to false.

    All properties are optional.

    Example:
    1. dns.lookup(hostname[, options], callback)

  16. def lookup(hostname: String, options: |[|[DnsOptions, RawOptions], Int], callback: DnsCallback1[String]): Unit

    Permalink

    Resolves a hostname (e.g.

    Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or AAAA (IPv6) record. options can be an object or integer. If options is not provided, then IPv4 and IPv6 addresses are both valid. If options is an integer, then it must be 4 or 6.

    Alternatively, options can be an object containing these properties:

    • family <Number> - The record family. If present, must be the integer 4 or 6. If not provided, both IP v4 and v6 addresses are accepted.
    • hints: <Number> - If present, it should be one or more of the supported getaddrinfo flags. If hints is not provided, then no flags are passed to getaddrinfo. Multiple flags can be passed through hints by logically ORing their values. See supported getaddrinfo flags for more information on supported flags.
    • all: <Boolean> - When true, the callback returns all resolved addresses in an array, otherwise returns a single address. Defaults to false.

    All properties are optional.

    Example:
    1. dns.lookup(hostname[, options], callback)

  17. def lookupService(address: String, port: Int, callback: DnsCallback2[String, String]): Unit

    Permalink

    Resolves the given address and port into a hostname and service using the operating system's underlying getnameinfo implementation.

    Resolves the given address and port into a hostname and service using the operating system's underlying getnameinfo implementation.

    If address is not a valid IP address, a TypeError will be thrown. The port will be coerced to a number. If it is not a legal port, a TypeError will be thrown.

    The callback has arguments (err, hostname, service). The hostname and service arguments are strings (e.g. 'localhost' and 'http' respectively).

    On error, err is an Error object, where err.code is the error code.

    Examples:
    1. dns.lookupService('127.0.0.1', 22, (err, hostname, service) => { ... })

    2. ,
    3. dns.lookupService(address, port, callback)

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  22. def resolve(hostname: String, callback: DnsCallback1[Array[String]]): Unit

    Permalink

    Uses the DNS protocol to resolve a hostname (e.g.

    Uses the DNS protocol to resolve a hostname (e.g. 'nodejs.org') into an array of the record types specified by rrtype. On error, err is an Error object, where err.code is one of the error codes listed here.

    hostname

    the hostname

    callback

    the callback function has arguments (err, addresses). When successful, addresses will be an array. The type of each item in addresses is determined by the record type, and described in the documentation for the corresponding lookup methods.

    Example:
    1. dns.resolve(hostname[, rrtype], callback)

  23. def resolve[A](hostname: String, rrtype: RRType, callback: DnsCallback1[A]): Unit

    Permalink

    Uses the DNS protocol to resolve a hostname (e.g.

    Uses the DNS protocol to resolve a hostname (e.g. 'nodejs.org') into an array of the record types specified by rrtype. On error, err is an Error object, where err.code is one of the error codes listed here.

    hostname

    the hostname

    rrtype

    the given rrtype Valid values for rrtype are: 'A' - IPV4 addresses, default 'AAAA' - IPV6 addresses 'MX' - mail exchange records 'TXT' - text records 'SRV' - SRV records 'PTR' - PTR records 'NS' - name server records 'CNAME' - canonical name records 'SOA' - start of authority record 'NAPTR' - name authority pointer record

    callback

    the callback function has arguments (err, addresses). When successful, addresses will be an array. The type of each item in addresses is determined by the record type, and described in the documentation for the corresponding lookup methods.

    Example:
    1. dns.resolve(hostname[, rrtype], callback)

  24. def resolve4(hostname: String, callback: DnsCallback1[Array[String]]): Unit

    Permalink

    Uses the DNS protocol to resolve a IPv4 addresses (A records) for the hostname.

    Uses the DNS protocol to resolve a IPv4 addresses (A records) for the hostname. The addresses argument passed to the callback function will contain an array of IPv4 addresses (e.g. ['74.125.79.104', '74.125.79.105', '74.125.79.106']).

    Example:
    1. dns.resolve4(hostname, callback)

  25. def resolve6(hostname: String, callback: DnsCallback1[Array[String]]): Unit

    Permalink

    Uses the DNS protocol to resolve a IPv6 addresses (AAAA records) for the hostname.

    Uses the DNS protocol to resolve a IPv6 addresses (AAAA records) for the hostname. The addresses argument passed to the callback function will contain an array of IPv6 addresses.

    Example:
    1. dns.resolve6(hostname, callback)

  26. def resolveCname(hostname: String, callback: DnsCallback1[Array[String]]): Unit

    Permalink

    Uses the DNS protocol to resolve CNAME records for the hostname.

    Uses the DNS protocol to resolve CNAME records for the hostname. The addresses argument passed to the callback function will contain an array of canonical name records available for the hostname (e.g. ['bar.example.com']).

    Example:
    1. dns.resolveCname(hostname, callback)

  27. def resolveMx(hostname: String, callback: DnsCallback1[MX]): Unit

    Permalink

    Uses the DNS protocol to resolve mail exchange records (MX records) for the hostname.

    Uses the DNS protocol to resolve mail exchange records (MX records) for the hostname. The addresses argument passed to the callback function will contain an array of objects containing both a priority and exchange property (e.g. [{priority: 10, exchange: 'mx.example.com'}, ...]).

    Example:
    1. dns.resolveMx(hostname, callback)

  28. def resolveNaptr(hostname: String, callback: DnsCallback1[NAPTR]): Unit

    Permalink

    Uses the DNS protocol to resolve regular expression based records (NAPTR records) for the hostname.

    Uses the DNS protocol to resolve regular expression based records (NAPTR records) for the hostname. The callback function has arguments (err, addresses). The addresses argument passed to the callback function will contain an array of objects with the following properties:

    • flags
    • service
    • regexp
    • replacement
    • order
    • preference
    Example:
    1. dns.resolveNaptr(hostname, callback)

  29. def resolveNs(hostname: String, callback: DnsCallback1[Array[String]]): Unit

    Permalink

    Uses the DNS protocol to resolve name server records (NS records) for the hostname.

    Uses the DNS protocol to resolve name server records (NS records) for the hostname. The addresses argument passed to the callback function will contain an array of name server records available for hostname (e.g., ['ns1.example.com', 'ns2.example.com']).

    Example:
    1. dns.resolveNs(hostname, callback)

  30. def resolvePtr(hostname: String, callback: DnsCallback1[Array[String]]): Unit

    Permalink

    Uses the DNS protocol to resolve pointer records (PTR records) for the hostname.

    Uses the DNS protocol to resolve pointer records (PTR records) for the hostname. The addresses argument passed to the callback function will be an array of strings containing the reply records.

    Example:
    1. dns.resolvePtr(hostname, callback)

  31. def resolveSoa(hostname: String, callback: DnsCallback1[SOA]): Unit

    Permalink

    Uses the DNS protocol to resolve a start of authority record (SOA record) for the hostname.

    Uses the DNS protocol to resolve a start of authority record (SOA record) for the hostname. The addresses argument passed to the callback function will be an object with the following properties:

    • nsname
    • hostmaster
    • serial
    • refresh
    • retry
    • expire
    • minttl
    Example:
    1. dns.resolveSoa(hostname, callback)

  32. def resolveSrv(hostname: String, callback: DnsCallback1[SRV]): Unit

    Permalink

    Uses the DNS protocol to resolve service records (SRV records) for the hostname.

    Uses the DNS protocol to resolve service records (SRV records) for the hostname. The addresses argument passed to the callback function will be an array of objects with the following properties:

    • priority
    • weight
    • port
    • name
    Example:
    1. dns.resolveSrv(hostname, callback)

  33. def resolveTxt(hostname: String, callback: DnsCallback1[Array[Array[String]]]): Unit

    Permalink

    Uses the DNS protocol to resolve text queries (TXT records) for the hostname.

    Uses the DNS protocol to resolve text queries (TXT records) for the hostname. The addresses argument passed to the callback function is is a two-dimentional array of the text records available for hostname (e.g., [ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]). Each sub-array contains TXT chunks of one record. Depending on the use case, these could be either joined together or treated separately.

    Example:
    1. dns.resolveTxt(hostname, callback)

  34. def reverse(ipAddress: String, callback: DnsCallback1[Array[String]]): Unit

    Permalink

    Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an array of hostnames.

    Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an array of hostnames. The callback function has arguments (err, hostnames), where hostnames is an array of resolved hostnames for the given ip. On error, err is an Error object, where err.code is one of the DNS error codes.

    Example:
    1. dns.reverse(ip, callback)

  35. def setServers(servers: Array[String]): Unit

    Permalink

    Sets the IP addresses of the servers to be used when resolving.

    Sets the IP addresses of the servers to be used when resolving. The servers argument is an array of IPv4 or IPv6 addresses. If a port specified on the address it will be removed. An error will be thrown if an invalid address is provided. The dns.setServers() method must not be called while a DNS query is in progress.

    Example:
    1. dns.setServers(servers)

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  38. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  39. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped