Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

dns-txt

Package Overview
Dependencies
1
Maintainers
1
Versions
2
Issues
File Explorer

Advanced tools

dns-txt

Encode/decode DNS-SD TXT record RDATA fields

    2.0.2latest

Version published
Maintainers
1
Weekly downloads
5,369,805
decreased by-20.43%

Weekly downloads

Readme

Source

dns-txt

Encode or decode the RDATA field in multicast DNS TXT records. For use with DNS-Based Service Discovery. For details see RFC 6763.

Build status js-standard-style abstract-encoding

Installation

npm install dns-txt

Usage

var txt = require('dns-txt')() var obj = { foo: 1, bar: 2 } var enc = txt.encode(obj) // <Buffer 05 66 6f 6f 3d 31 05 62 61 72 3d 32> txt.decode(enc) // { foo: '1', bar: '2' }

API

The encoder and decoder conforms to RFC 6763.

Initialize

The module exposes a constructor function which can be called with an optional options object:

var txt = require('dns-txt')({ binary: true })

The options are:

  • binary - If set to true all values will be returned as Buffer objects. The default behavior is to turn all values into strings. But according to the RFC the values can be any binary data. If you expect binary data, use this option.
txt.encode(obj, [buffer], [offset])

Takes a key/value object and returns a buffer with the encoded TXT record. If a buffer is passed as the second argument the object should be encoded into that buffer. Otherwise a new buffer should be allocated If an offset is passed as the third argument the object should be encoded at that byte offset. The byte offset defaults to 0.

This module does not actively validate the key/value pairs, but keep the following in rules in mind:

  • To be RFC compliant, each key should conform with the rules as specified in section 6.4.

  • To be RFC compliant, each value should conform with the rules as specified in section 6.5.

After encoding txt.encode.bytes is set to the amount of bytes used to encode the object.

txt.decode(buffer, [offset], [length])

Takes a buffer and returns a decoded key/value object. If an offset is passed as the second argument the object should be decoded from that byte offset. The byte offset defaults to 0. Note that all keys will be lowercased and all values will be Buffer objects.

After decoding txt.decode.bytes is set to the amount of bytes used to decode the object.

txt.encodingLength(obj)

Takes a single key/value object and returns the number of bytes that the given object would require if encoded.

License

MIT

Keywords

FAQs

What is dns-txt?

Encode/decode DNS-SD TXT record RDATA fields

Is dns-txt popular?

The npm package dns-txt receives a total of 4,478,374 weekly downloads. As such, dns-txt popularity was classified as popular.

Is dns-txt well maintained?

We found that dns-txt demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 24 Apr 2016

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc