Renamed checkIfPortIsInUse to isPortInUse

Author: luca-vogels

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lup-system",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "NodeJS library to retrieve system information and utilization.",
   "main": "./lib/index",
   "types": "./lib/index.d.ts",

src/__tests__/Net.test.ts

@@ -1,4 +1,4 @@
-import { checkIfPortIsInUse, getNetworkInterfaces, stopNetworkUtilizationComputation } from '../net';
+import { isPortInUse, getNetworkInterfaces, stopNetworkUtilizationComputation } from '../net';
 import net from 'net';
 
 test('getNetworkInterfaces', async () => {
@@ -8,11 +8,11 @@ test('getNetworkInterfaces', async () => {
   expect(nics.length).toBeGreaterThan(0);
 }, 10000);
 
-test('checkIfPortIsInUse(12345)', async () => {
+test('isPortInUse(12345)', async () => {
   const port = 12345;
 
   // port should be free
-  const isInUse1 = await checkIfPortIsInUse(port);
+  const isInUse1 = await isPortInUse(port);
   expect(isInUse1).toBe(false);
 
   // start a server
@@ -21,7 +21,7 @@ test('checkIfPortIsInUse(12345)', async () => {
   await new Promise<void>((resolve) => server.listen(port, '0.0.0.0', resolve));
 
   // port should now be in use
-  const isInUse2 = await checkIfPortIsInUse(port);
+  const isInUse2 = await isPortInUse(port);
   expect(isInUse2).toBe(true);
 
   server.close();

src/net.ts

@@ -175,7 +175,7 @@ export function stopNetworkUtilizationComputation() {
  * @param bindAddress Address of the interface to bind to (default '0.0.0.0' which binds to all interfaces).
  * @returns Promise that resolves to true if the port is in use, false otherwise.
  */
-export async function checkIfPortIsInUse(port: number, bindAddress: string = '0.0.0.0'): Promise<boolean> {
+export async function isPortInUse(port: number, bindAddress: string = '0.0.0.0'): Promise<boolean> {
   const server = net.createServer();
   return new Promise((resolve) => {
     server.unref();