port-numbers 6.0.0 → 7.0.0

package/README.md

@@ -1,36 +1,36 @@
 # port-numbers
-[![](https://img.shields.io/npm/v/port-numbers.svg?style=flat)](https://www.npmjs.org/package/port-numbers) [![](https://img.shields.io/npm/dm/port-numbers.svg)](https://www.npmjs.org/package/port-numbers)
+[![](https://img.shields.io/npm/v/port-numbers.svg?style=flat)](https://www.npmjs.org/package/port-numbers) [![](https://img.shields.io/npm/dm/port-numbers.svg)](https://www.npmjs.org/package/port-numbers) [![](https://packagephobia.com/badge?p=port-numbers)](https://packagephobia.com/result?p=port-numbers)
+
 > Get information on network port numbers and services, based on [IANA's public listing](http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml).
 
-### Installation
+### Usage
 ```
 npm i port-numbers
 ```
-### Example
 ```js
-const portNumbers = require('port-numbers');
+import {getService, getPort} from "port-numbers";
 
-portNumbers.getService(6379);
+getService(6379);
 // { name: 'redis', description: 'An advanced key-value cache and store' }
-portNumbers.getService(26257);
+getService(26257);
 // { name: 'cockroach', description: 'CockroachDB' }
-portNumbers.getService(123, 'udp');
+getService(123, 'udp');
 // { name: 'ntp', description: 'Network Time Protocol' }
 
-portNumbers.getPort('redis');
+getPort('redis');
 // { port: 6379, protocol: 'tcp', description: 'An advanced key-value cache and store' }
-portNumbers.getPort('cockroach');
+getPort('cockroach');
 // { port: 26257, protocol: 'tcp', description: 'CockroachDB' }
-portNumbers.getPort('ntp', 'udp');
+getPort('ntp', 'udp');
 // { port: 123, protocol: 'udp', description: 'Network Time Protocol' }
 ```
 
-### APIs
-#### portNumbers.getService(port[, protocol])
+### API
+#### getService(port[, protocol])
 - `port` *Number* : the port to lookup. Required.
 - `protocol` *String* : the protocol. Default: `tcp`.
 
-#### portNumbers.getPort(service[, protocol])
+#### getPort(service[, protocol])
 - `service` *String* : the service to lookup. Required.
 - `protocol` *String* : the protocol. Default: `tcp`.
 

package/index.js

@@ -1,25 +1,25 @@
-"use strict";
+import {readFileSync} from "node:fs";
 
 let ports, services;
 
 // port -> service
-module.exports.getService = (port, protocol = "tcp") => {
+export function getService(port, protocol = "tcp") {
   if (typeof port !== "number") throw new Error("expected a 'number'");
-  if (!ports) ports = require("./ports.json");
+  if (!ports) ports = JSON.parse(readFileSync(new URL("ports.json", import.meta.url)));
   return ports[`${port}/${protocol}`] || null;
-};
+}
 
 // service -> port
-module.exports.getPort = (service, protocol = "tcp") => {
+export function getPort(service, protocol = "tcp") {
   if (typeof service !== "string") throw new Error("expected a 'string'");
-  if (!services) services = require("./services.json");
+  if (!services) services = JSON.parse(readFileSync(new URL("services.json", import.meta.url)));
 
   // services are always lowercase
   const entry = services[service.toLowerCase()];
   if (!entry) return null;
 
   // filter non-matching protocols
-  const port = entry.ports.filter(port => /\w+$/.exec(port)[0] === protocol)[0];
+  const port = entry.ports.find(port => /\w+$/.exec(port)[0] === protocol);
   if (!port) return null;
 
   // return the first matching port
@@ -28,4 +28,4 @@ module.exports.getPort = (service, protocol = "tcp") => {
     protocol: /\w+$/.exec(port)[0],
     description: entry.description
   };
-};
+}

package/package.json

@@ -1,42 +1,29 @@
 {
   "name": "port-numbers",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "Get information on network port numbers and services, based on IANA's public listing",
-  "author": "silverwind <me@silverwind.io> (https://github.com/silverwind)",
-  "license": "BSD-2-Clause",
+  "author": "silverwind",
   "repository": "silverwind/port-numbers",
-  "scripts": {
-    "test": "make test"
-  },
+  "license": "BSD-2-Clause",
+  "type": "module",
+  "sideEffects": false,
   "engines": {
-    "node": ">=10"
+    "node": ">=16"
   },
   "files": [
-    "index.js",
-    "ports.json",
-    "services.json"
-  ],
-  "keywords": [
-    "port",
-    "port-numbers",
-    "numbers",
-    "tcp",
-    "udp",
-    "network",
-    "networking",
-    "iana",
-    "well-known"
+    "./index.js",
+    "./ports.json",
+    "./services.json"
   ],
   "devDependencies": {
-    "csv-parse": "4.8.8",
-    "eslint": "6.8.0",
-    "eslint-config-silverwind": "11.0.2",
-    "got": "10.7.0",
-    "jest": "25.2.3",
-    "updates": "10.2.6",
-    "versions": "8.2.7"
-  },
-  "jest": {
-    "verbose": false
+    "d3-dsv": "3.0.1",
+    "eslint": "8.40.0",
+    "eslint-config-silverwind": "71.0.3",
+    "fetch-enhanced": "11.1.1",
+    "got": "12.6.0",
+    "undici": "5.22.1",
+    "updates": "14.1.0",
+    "versions": "11.0.0",
+    "vitest": "0.31.0"
   }
 }