Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/upset-socks-clean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@nodesecure/contact": minor
---

Expose NsResolver class and add API documentation
2 changes: 2 additions & 0 deletions workspaces/contact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ console.log({ illuminated, expired });

## API

- [NsResolver](./docs/NsResolver.md)

Contact is defined by the following TypeScript interface:
```ts
interface Contact {
Expand Down
33 changes: 33 additions & 0 deletions workspaces/contact/docs/NsResolver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# NsResolver

`NsResolver` is a utility class that collects email addresses and detects which ones have **expired domain names** by performing DNS NS record lookups.

It is used internally by `ContactExtractor` but is also exported for direct use.

## Usage example

```ts
import { NsResolver } from "@nodesecure/contact";

const resolver = new NsResolver();

resolver.registerEmail("alice@valid-domain.com");
resolver.registerEmail("bob@expired-domain.xyz");

const expired = await resolver.getExpired();
console.log(expired); // ["bob@expired-domain.xyz"] (if NS lookup fails)
```

## API

### `new NsResolver()`

Creates a new instance. The DNS resolver is pre-configured to use Cloudflare (`1.1.1.1`) and Google (`8.8.8.8`) public DNS servers.

### `registerEmail(email: string | undefined | null): void`

Registers an email address for later NS resolution. Silently ignores `null`, `undefined`, and blank strings.

### `getExpired(): Promise<string[]>`

Resolves NS records for the domain of every registered email in parallel. Returns the list of emails whose domain **failed** the NS lookup (i.e. the domain is expired or does not exist).
1 change: 1 addition & 0 deletions workspaces/contact/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ export * from "./ContactExtractor.class.ts";
export {
compareContact
} from "./utils/index.ts";
export { NsResolver } from "./NsResolver.class.ts";