https://github.com/hildjj/resolv-conf

Parse resolv.conf files in node
https://github.com/hildjj/resolv-conf

Last synced: 19 days ago
JSON representation

Parse resolv.conf files in node

• Host: GitHub
• URL: https://github.com/hildjj/resolv-conf
• Owner: hildjj
• License: mit
• Created: 2020-12-29T07:19:28.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-07T20:01:21.000Z (6 months ago)
• Last Synced: 2024-10-18T20:34:48.710Z (28 days ago)
• Language: JavaScript
• Size: 559 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Parse resolv.conf

This repo uses the Linux documentation for

[resolv.conf(5)](https://man7.org/linux/man-pages/man5/resolv.conf.5.html) to

parse the configuration for DNS resolution on your system.  Windows uses a

different approach, so the best you can do is likely the Node built-in

[`dns.getServers()`](https://nodejs.org/api/dns.html#dns_dns_getservers).

Note that the defaults and environment variables listed in the docs were also

implemented.

## Install

```sh

npm install resolv-conf

```

## Usage

```js

import {parseFile, parse} from 'resolv-conf';

const config = await parseFile();  // filename is optional

// returns:

// {

//   nameserver: [ '127.0.0.1', '::1' ],

//   options: { ndots: 1 },

//   searchlist: [...],

//   sortlist: [ { addr: ..., mask: ...}, ...]

//   errors: [ {text: "...", location:...} ]

// }

// if you already have text from the file:

const config2 = parse(text);

```

## Options

Options will have dashes turned into underscores.  For example, `no-aaaa` will be

available as `config.options.no_aaaa`.

## Errors

Unrecoverable parse errors will throw an exception with `location`,

`expected`, `found`, and `message` properties.

Recoverable errors (e.g. invalid IP addresses) will show up in the result

object in the `errors` property, and valid defaults will be chosen for that

option if need be.

## Status

[![Tests](https://github.com/hildjj/resolv-conf/actions/workflows/node.js.yml/badge.svg)](https://github.com/hildjj/resolv-conf/actions/workflows/node.js.yml)

[![codecov](https://codecov.io/gh/hildjj/resolv-conf/graph/badge.svg?token=Y4Z2ALWXAA)](https://codecov.io/gh/hildjj/resolv-conf)