Skip to content

refactor: updated and refactored for esm using latest npm libraries #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor: updated and refactored for esm using latest npm libraries #11

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
553ebf5
refactor: updated and refactored for esm using latest npm library ver…
timint Jul 12, 2025
a37ad7a
refactor: more refactoring (eslint, xo, imports etc)
timint Aug 21, 2025
dbfc341
chore: update npm libraries to latest versions
timint Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .eslintignore
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions .husky/commit-msg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx commitlint --edit $1
1 change: 1 addition & 0 deletions .husky/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx lint-staged
5 changes: 0 additions & 5 deletions .lintstagedrc.js
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions .prettierrc.js
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions .remarkrc.js
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions .xo-config.js
View file
Open in desktop

This file was deleted.

20 changes: 3 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
</div>
<hr />


## Table of Contents

* [Install](#install)
Expand Down Expand Up @@ -67,7 +66,6 @@
* [Contributors](#contributors)
* [License](#license)


## Install

```sh
Expand All @@ -82,7 +80,6 @@ npm install tangerine undici
+const resolver = new Tangerine();
```


## Foreword

### What is this project about
Expand Down Expand Up @@ -120,7 +117,6 @@ After years of using the Node.js internal DNS module, we ran into these recurrin

Thanks to the authors of [dohdec](https://github.com/hildjj/dohdec), [dns-packet](https://github.com/mafintosh/dns-packet), [dns2](https://github.com/song940/node-dns), and [native-dnssec-dns](https://github.com/EduardoRuizM/native-dnssec-dns) – which made this project possible and were used for inspiration.


## Features

:tangerine: Tangerine is a 1:1 **drop-in replacement with DNS over HTTPS ("DoH")** for [dns.promises.Resolver](https://nodejs.org/api/dns.html#resolveroptions):
Expand Down Expand Up @@ -159,7 +155,6 @@ All existing <code>syscall</code> values have been preserved:
* `resolveSoa` → `querySoa`
* `reverse` → `getHostByAddr`


## Usage and Examples

### ECMAScript modules (ESM)
Expand Down Expand Up @@ -188,7 +183,6 @@ const tangerine = new Tangerine();
tangerine.resolve('forwardemail.net').then(console.log);
```


## API

### `new Tangerine(options[, request])`
Expand Down Expand Up @@ -369,7 +363,6 @@ console.log('mx', mx);

**Pull requests are welcome to add support for other `rrtype` values for this method.**


## Options

Similar to the `options` argument from `new dns.promises.Resolver(options)` invocation – :tangerine: Tangerine also has its own options with default `dns` behavior mirrored. See [index.js](https://github.com/forwardemail/nodejs-dns-over-https-tangerine/blob/main/index.js) for more insight into how these options work.
Expand Down Expand Up @@ -397,8 +390,7 @@ Similar to the `options` argument from `new dns.promises.Resolver(options)` invo
| `setCacheArgs` | `Function` | `(key, result) => []` | This is a helper function used for cache store providers such as [ioredis](https://github.com/luin/ioredis) or [lru-cache](https://github.com/isaacs/node-lru-cache) which support more than two arguments to `cache.set()` function. See [Cache](#cache) documentation below for more insight and examples into how this works. You may want to set this to something such as `(key, result) => [ 'PX', Math.round(result.ttl * 1000) ]` if you are using `ioredis`. |
| `returnHTTPErrors` | `Boolean` | `false` | Whether to return HTTP errors instead of mapping them to corresponding DNS errors. |
| `smartRotate` | `Boolean` | `true` | Whether to do smart server rotation if servers fail. |
| `defaultHTTPErrorMessage` | `String` | `"Unsuccessful HTTP response"` | Default fallback message if `statusCode` returned from HTTP request was not found in [http.STATUS_CODES](https://nodejs.org/api/http.html#httpstatus_codes). |

| `defaultHTTPErrorMessage` | `String` | `"Unsuccessful HTTP response"` | Default fallback message if `statusCode` returned from HTTP request was not found in [http.STATUS\_CODES](https://nodejs.org/api/http.html#httpstatus_codes). |

## Cache

Expand Down Expand Up @@ -468,7 +460,6 @@ await tangerine.resolve('forwardemail.net'); // uses cached value

This purge cache feature is useful for DNS records that have recently changed and have had their caches purged at the relevant DNS provider (e.g. [Cloudflare's Purge Cache tool](https://1.1.1.1/purge-cache/)).


## Compatibility

The only known compatibility issue is for locally running DNS servers that have wildcard DNS matching.
Expand All @@ -477,7 +468,6 @@ If you are using `dnsmasq` with a wildcard match on "localhost" to "127.0.0.1",

The reason is because :tangerine: Tangerine only looks at either `/etc/hosts` (macOS/Linux) and `C:/Windows/System32/drivers/etc/hosts` (Windows). It does not lookup BIND, dnsmasq, or other configurations running locally. We would welcome a PR to resolve this (see `isCI` usage in test folder) – however it is a non-issue, as the workaround is to simply append a new line to the hostfile of `127.0.0.1 foo.localhost`.


## Debugging

If you run into issues while using :tangerine: Tangerine, then these recommendations may help:
Expand All @@ -492,7 +482,6 @@ If you run into issues while using :tangerine: Tangerine, then these recommendat

* Assuming you are not allergic, try eating a [nutritious](https://en.wikipedia.org/wiki/Tangerine#Nutrition) :tangerine: tangerine.


## Benchmarks

Contributors can run benchmarks locally by cloning the repository, installing dependencies, and running the benchmarks script:
Expand Down Expand Up @@ -590,11 +579,11 @@ dns.promises.reverse with caching x 5,164,258 ops/sec ±0.96% (86 runs sampled)
+Fastest without caching is: tangerine.reverse GET without caching
```

---
***

You can also [run the benchmarks yourself](#benchmarks).

---
***

Provided below are additional benchmark tests we have run:

Expand Down Expand Up @@ -712,19 +701,16 @@ phin POST request x 714 ops/sec ±17.39% (62 runs sampled)
Fastest is undici GET request
```


## Contributors

| Name | Website |
| ----------------- | -------------------------- |
| **Forward Email** | <https://forwardemail.net> |


## License

[MIT](LICENSE) © [Forward Email](https://forwardemail.net)


##

<a href="#"><img src="https://raw.githubusercontent.com/forwardemail/nodejs-dns-over-https-tangerine/main/media/footer.png" alt="#" /></a>
4 changes: 3 additions & 1 deletion ava.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
module.exports = {
const config = {
files: ['test/*.js', 'test/**/*.js']
};

export default config;
Loading