unix-socket-address 0.0.2 → 0.1.0

package/README.md

@@ -3,16 +3,18 @@
 ## Runtime agnostic core Unix Socket IpAddr class base on Rust implementation.
 
 ## Installation
+
 ```bash
 npm i unix-socket-address
 ```
 
 ## Examples
+
 ```typescript
- const socketAddress = new SocketAddrUnix('/tmp/app.sock');
- const windowsNamedPipeAddress = new SocketAddrUnix('\\\\.\\pipe\\app');
+const socketAddress = new SocketAddrUnix("/tmp/app.sock");
+const windowsNamedPipeAddress = new SocketAddrUnix("\\\\.\\pipe\\app");
 
-server.listen(socketAddress.asNodeListenerOptions())
- ```
+server.listen(socketAddress.asNodeListener());
+```
 
- ## Full [Documentation](https://luolapeikko.github.io/net-address-base/)
+## Full [Documentation](https://luolapeikko.github.io/net-address-base/)

package/dist/index.cjs

@@ -1,2 +1,2 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=class{family=`unix`;path;constructor(e){this.path=e}asNodeListenerOptions(){return{path:this.path}}toString(){return this.path}};exports.SocketAddrUnix=e;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=class{family=`unix`;path;constructor(e){this.path=e}asNodeListener(){return{path:this.path}}toString(){return this.path}equals(e){return`family`in e&&this.family===e.family&&this.path===e.path}};exports.SocketAddrUnix=e;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":[],"sources":["../src/SocketAddrUnix.ts"],"sourcesContent":["/**\n * Represents a Unix domain socket address, consisting of a file system path.\n * @example\n * const socketAddress = new SocketAddrUnix('/tmp/app.sock');\n * const windowsNamedPipeAddress = new SocketAddrUnix('\\\\\\\\.\\\\pipe\\\\app');\n */\nexport class SocketAddrUnix {\n\tpublic readonly family = 'unix';\n\tpublic readonly path: string;\n\n\tpublic constructor(path: string) {\n\t\tthis.path = path;\n\t}\n\n\tpublic asNodeListenerOptions(): {path: string} {\n\t\treturn {\n\t\t\tpath: this.path,\n\t\t};\n\t}\n\n\tpublic toString(): string {\n\t\treturn this.path;\n\t}\n}\n"],"mappings":"mEAMA,IAAa,EAAb,KAA4B,CAC3B,OAAyB,OACzB,KAEA,YAAmB,EAAc,CAChC,KAAK,KAAO,CACb,CAEA,uBAA+C,CAC9C,MAAO,CACN,KAAM,KAAK,IACZ,CACD,CAEA,UAA0B,CACzB,OAAO,KAAK,IACb,CACD"}
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/SocketAddrUnix.ts"],"sourcesContent":["/**\n * Represents a Unix domain socket address, consisting of a file system path.\n * @example\n * const socketAddress = new SocketAddrUnix('/tmp/app.sock');\n * const windowsNamedPipeAddress = new SocketAddrUnix('\\\\\\\\.\\\\pipe\\\\app');\n */\nexport class SocketAddrUnix {\n\tpublic readonly family = 'unix';\n\tpublic readonly path: string;\n\n\tpublic constructor(path: string) {\n\t\tthis.path = path;\n\t}\n\n\tpublic asNodeListener(): {path: string} {\n\t\treturn {\n\t\t\tpath: this.path,\n\t\t};\n\t}\n\n\tpublic toString(): string {\n\t\treturn this.path;\n\t}\n\n\t/**\n\t * Compares this Unix socket path with another for equality.\n\t * @param other instance of another Unix socket path to compare with.\n\t * @returns `true` if both paths are equal, otherwise `false`.\n\t * @since v0.1.0\n\t */\n\tpublic equals(other: SocketAddrUnix | object): boolean {\n\t\treturn 'family' in other && this.family === other.family && this.path === other.path;\n\t}\n}\n"],"mappings":"mEAMA,IAAa,EAAb,KAA4B,CAC3B,OAAyB,OACzB,KAEA,YAAmB,EAAc,CAChC,KAAK,KAAO,CACb,CAEA,gBAAwC,CACvC,MAAO,CACN,KAAM,KAAK,IACZ,CACD,CAEA,UAA0B,CACzB,OAAO,KAAK,IACb,CAQA,OAAc,EAAyC,CACtD,MAAO,WAAY,GAAS,KAAK,SAAW,EAAM,QAAU,KAAK,OAAS,EAAM,IACjF,CACD"}

package/dist/index.d.cts

@@ -9,10 +9,17 @@ declare class SocketAddrUnix {
   readonly family = "unix";
   readonly path: string;
   constructor(path: string);
-  asNodeListenerOptions(): {
+  asNodeListener(): {
     path: string;
   };
   toString(): string;
+  /**
+  * Compares this Unix socket path with another for equality.
+  * @param other instance of another Unix socket path to compare with.
+  * @returns `true` if both paths are equal, otherwise `false`.
+  * @since v0.1.0
+  */
+  equals(other: SocketAddrUnix | object): boolean;
 }
 //#endregion
 export { SocketAddrUnix };

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/SocketAddrUnix.ts"],"mappings":";;AAMA;;;;;cAAa,cAAA;EAAA,SACI,MAAA;EAAA,SACA,IAAA;EAEhB,WAAA,CAAmB,IAAA;EAInB,qBAAA;IAAiC,IAAA;EAAA;EAMjC,QAAA;AAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/SocketAddrUnix.ts"],"mappings":";;AAMA;;;;;cAAa,cAAA;EAAA,SACI,MAAA;EAAA,SACA,IAAA;EAEhB,WAAA,CAAmB,IAAA;EAInB,cAAA;IAA0B,IAAA;EAAA;EAM1B,QAAA;;;AAUqB;;;;EAArB,MAAA,CAAc,KAAA,EAAO,cAAA;AAAA"}

package/dist/index.d.mts

@@ -9,10 +9,17 @@ declare class SocketAddrUnix {
   readonly family = "unix";
   readonly path: string;
   constructor(path: string);
-  asNodeListenerOptions(): {
+  asNodeListener(): {
     path: string;
   };
   toString(): string;
+  /**
+  * Compares this Unix socket path with another for equality.
+  * @param other instance of another Unix socket path to compare with.
+  * @returns `true` if both paths are equal, otherwise `false`.
+  * @since v0.1.0
+  */
+  equals(other: SocketAddrUnix | object): boolean;
 }
 //#endregion
 export { SocketAddrUnix };

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/SocketAddrUnix.ts"],"mappings":";;AAMA;;;;;cAAa,cAAA;EAAA,SACI,MAAA;EAAA,SACA,IAAA;EAEhB,WAAA,CAAmB,IAAA;EAInB,qBAAA;IAAiC,IAAA;EAAA;EAMjC,QAAA;AAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/SocketAddrUnix.ts"],"mappings":";;AAMA;;;;;cAAa,cAAA;EAAA,SACI,MAAA;EAAA,SACA,IAAA;EAEhB,WAAA,CAAmB,IAAA;EAInB,cAAA;IAA0B,IAAA;EAAA;EAM1B,QAAA;;;AAUqB;;;;EAArB,MAAA,CAAc,KAAA,EAAO,cAAA;AAAA"}

package/dist/index.mjs

@@ -1,2 +1,2 @@
-var e=class{family=`unix`;path;constructor(e){this.path=e}asNodeListenerOptions(){return{path:this.path}}toString(){return this.path}};export{e as SocketAddrUnix};
+var e=class{family=`unix`;path;constructor(e){this.path=e}asNodeListener(){return{path:this.path}}toString(){return this.path}equals(e){return`family`in e&&this.family===e.family&&this.path===e.path}};export{e as SocketAddrUnix};
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/SocketAddrUnix.ts"],"sourcesContent":["/**\n * Represents a Unix domain socket address, consisting of a file system path.\n * @example\n * const socketAddress = new SocketAddrUnix('/tmp/app.sock');\n * const windowsNamedPipeAddress = new SocketAddrUnix('\\\\\\\\.\\\\pipe\\\\app');\n */\nexport class SocketAddrUnix {\n\tpublic readonly family = 'unix';\n\tpublic readonly path: string;\n\n\tpublic constructor(path: string) {\n\t\tthis.path = path;\n\t}\n\n\tpublic asNodeListenerOptions(): {path: string} {\n\t\treturn {\n\t\t\tpath: this.path,\n\t\t};\n\t}\n\n\tpublic toString(): string {\n\t\treturn this.path;\n\t}\n}\n"],"mappings":"AAMA,IAAa,EAAb,KAA4B,CAC3B,OAAyB,OACzB,KAEA,YAAmB,EAAc,CAChC,KAAK,KAAO,CACb,CAEA,uBAA+C,CAC9C,MAAO,CACN,KAAM,KAAK,IACZ,CACD,CAEA,UAA0B,CACzB,OAAO,KAAK,IACb,CACD"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/SocketAddrUnix.ts"],"sourcesContent":["/**\n * Represents a Unix domain socket address, consisting of a file system path.\n * @example\n * const socketAddress = new SocketAddrUnix('/tmp/app.sock');\n * const windowsNamedPipeAddress = new SocketAddrUnix('\\\\\\\\.\\\\pipe\\\\app');\n */\nexport class SocketAddrUnix {\n\tpublic readonly family = 'unix';\n\tpublic readonly path: string;\n\n\tpublic constructor(path: string) {\n\t\tthis.path = path;\n\t}\n\n\tpublic asNodeListener(): {path: string} {\n\t\treturn {\n\t\t\tpath: this.path,\n\t\t};\n\t}\n\n\tpublic toString(): string {\n\t\treturn this.path;\n\t}\n\n\t/**\n\t * Compares this Unix socket path with another for equality.\n\t * @param other instance of another Unix socket path to compare with.\n\t * @returns `true` if both paths are equal, otherwise `false`.\n\t * @since v0.1.0\n\t */\n\tpublic equals(other: SocketAddrUnix | object): boolean {\n\t\treturn 'family' in other && this.family === other.family && this.path === other.path;\n\t}\n}\n"],"mappings":"AAMA,IAAa,EAAb,KAA4B,CAC3B,OAAyB,OACzB,KAEA,YAAmB,EAAc,CAChC,KAAK,KAAO,CACb,CAEA,gBAAwC,CACvC,MAAO,CACN,KAAM,KAAK,IACZ,CACD,CAEA,UAA0B,CACzB,OAAO,KAAK,IACb,CAQA,OAAc,EAAyC,CACtD,MAAO,WAAY,GAAS,KAAK,SAAW,EAAM,QAAU,KAAK,OAAS,EAAM,IACjF,CACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "unix-socket-address",
-	"version": "0.0.2",
+	"version": "0.1.0",
 	"description": "Unix domain socket address instances",
 	"main": "./dist/index.cjs",
 	"module": "./dist/index.mjs",