diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fef1fb7..1fb9687 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - node-version: [16.x, 18.x] + node-version: [18.x, 20.x] fail-fast: false steps: - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 diff --git a/README.md b/README.md index b5aa440..fcc23fb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # NodeSecure domain-check + ![version](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&url=https://raw.githubusercontent.com/NodeSecure/domain-check/main/package.json&query=$.version&label=Version) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/NodeSecure/domain-check/graphs/commit-activity) [![OpenSSF @@ -9,7 +10,8 @@ Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/dom NodeSecure (npm) domain-check analysis package ## Requirements -- [Node.js](https://nodejs.org/en/) v16 or higher + +- [Node.js](https://nodejs.org/en/) v18 or higher ## Getting Started @@ -24,9 +26,9 @@ $ yarn add @nodesecure/domain-check ## Usage example ```js -import { whois, resolveMxRecords } from '@nodesecure/domain-check'; +import { whois, resolveMxRecords } from "@nodesecure/domain-check"; -const myDomain = 'google.com'; +const myDomain = "google.com"; const domainExpirationDate = await whois(myDomain); const mxRecords = await resolveMxRecords(myDomain); @@ -37,12 +39,15 @@ const mxRecords = await resolveMxRecords(myDomain); ### whois(domain: string, server = "whois.iana.org"): string ### resolveMxRecords(domain: string): (Array | { error: string, context: Error }) + > An array of MX exchanges, or an object with error information for the given domain. ## Contributors ✨ + [![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-) + Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): diff --git a/package.json b/package.json index 48df763..b5c435a 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,9 @@ "exports": "./src/index.js", "main": "./src/index.js", "type": "module", + "engines": { + "node": ">=18.0.0" + }, "types": "./index.d.ts", "scripts": { "dev": "node ./src/index.js",