f

README.md

@@ -42,24 +42,40 @@
 npm i detect-port
 ```
 
+CommonJS
+
 ```javascript
-const detect = require('detect-port');
-/**
- * use as a promise
- */
+const { detect } = require('detect-port');
 
 detect(port)
-  .then(_port => {
-    if (port == _port) {
+  .then(realPort => {
+    if (port == realPort) {
       console.log(`port: ${port} was not occupied`);
     } else {
-      console.log(`port: ${port} was occupied, try port: ${_port}`);
+      console.log(`port: ${port} was occupied, try port: ${realPort}`);
     }
   })
   .catch(err => {
     console.log(err);
   });
+```
+
+ESM and TypeScript
 
+```ts
+import { detect } from 'detect-port';
+
+detect(port)
+  .then(realPort => {
+    if (port == realPort) {
+      console.log(`port: ${port} was not occupied`);
+    } else {
+      console.log(`port: ${port} was occupied, try port: ${realPort}`);
+    }
+  })
+  .catch(err => {
+    console.log(err);
+  });
 ```
 
 ## Command Line Tool

src/index.ts

@@ -3,4 +3,7 @@ import { detectPort } from './detect-port.js';
 export default detectPort;
 
 export * from './detect-port.js';
+// keep alias detectPort to detect
+export const detect = detectPort;
+
 export * from './wait-port.js';

test/detect-port.test.ts

@@ -4,6 +4,8 @@ import { strict as assert } from 'node:assert';
 import { ip } from 'address';
 import mm from 'mm';
 import { detectPort } from '../src/detect-port.js';
+import detect from '../src/index.js';
+import { detect as detect2 } from '../src/index.js';
 
 describe('test/detect-port.test.ts', () => {
   afterEach(mm.restore);
@@ -74,6 +76,13 @@ describe('test/detect-port.test.ts', () => {
       assert(port >= 1024 && port < 65535);
     });
 
+    it('should detect work', async () => {
+      let port = await detect();
+      assert(port >= 1024 && port < 65535);
+      port = await detect2();
+      assert(port >= 1024 && port < 65535);
+    });
+
     it('with occupied port, like "listen EACCES: permission denied"', async () => {
       const port = 80;
       const realPort = await detectPort(port);