unbound - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "unbound",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Bindings to libunbound for node.js",
@@ -5,0 +5,0 @@ "keywords": [

README.md

 # unbound
 
-Bindings to libunbound for node.js.
+Bindings to [libunbound] for node.js.
 
@@ -25,20 +25,28 @@ ## Usage
 
-See: https://github.com/NLnetLabs/unbound/blob/master/libunbound/unbound.h
+The API is a direct mapping to [libunbound calls][header].
 
-- `Unbound.version()` - Returns version string.
-- `Unbound#setOption(opt, val)`
-- `Unbound#getOption(opt)`
-- `Unbound#setConfig(file)`
-- `Unbound#setForward(addrname)`
-- `Unbound#setStub(zone, addr, [isPrime=false])`
-- `Unbound#setResolvConf(filename)`
-- `Unbound#setHosts(filename)`
-- `Unbound#addTrustAnchor(ta)`
-- `Unbound#addTrustAnchorFile(file, [autr=false])`
-- `Unbound#addTrustedKeys(file)`
-- `Unbound#addZone(zoneName, zoneType)`
-- `Unbound#removeZone(zoneName)`
-- `Unbound#addData(data)`
-- `Unbound#removeData(data)`
-- `Unbound#resolve(name, [type=A], [class=IN])`
+- `Unbound.version()` - Return unbound version string.
+- `Unbound#setOption(opt, val)` - Set [resolver option][conf]. Note that the
+  trailing colon is not necessary. Values will be cast to strings (`null=''`,
+  `bool='yes'/'no'`, `num=num.toString(10)`).
+- `Unbound#getOption(opt)` - Get [resolver option][conf]. Note that the
+  trailing colon is not necessary. Return values will be cast to bools,
+  numbers, and nulls where appropriate.
+- `Unbound#setConfig(file)` - Read unbound config file.
+- `Unbound#setForward(addr)` - Set host to forward DNS queries to.
+- `Unbound#setStub(zone, addr, [prime=false])` - Setup stub zone.
+- `Unbound#setResolvConf(filename)` - Read from `resolv.conf`.
+- `Unbound#setHosts(filename)` - Read from an `/etc/hosts` file.
+- `Unbound#addTrustAnchor(ta)` - Add a trust anchor (DS/DNSKEY presentation).
+- `Unbound#addTrustAnchorFile(file, [autr=false])` - Add trust anchor file.
+  Set `autr` for auto-updating and reading.
+- `Unbound#addTrustedKeys(file)` - Add bind-style trust anchors.
+- `Unbound#addZone(zoneName, zoneType)` - Add a zone to the local authority
+  info.
+- `Unbound#removeZone(zoneName)` - Remove zone.
+- `Unbound#addData(data)` - Add localdata to the local authority info.
+- `Unbound#removeData(data)` - Remove data.
+- `Unbound#resolve(name, [type=A], [class=IN])` - Asynchronous recursive
+  resolution (returns a `Promise`). `type` and `class` are raw qtypes and
+  qclasses (no strings!). See above example for return value.
 
@@ -56,1 +64,5 @@ ## Contribution and License Agreement
 See LICENSE for more info.
+
+[libunbound]: https://www.unbound.net/
+[header]: https://github.com/NLnetLabs/unbound/blob/master/libunbound/unbound.h
+[conf]: https://www.unbound.net/documentation/unbound.conf.html

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29096

increased by19.29%

Number of lines in readme file

67

increased by21.82%

No dependency changes