net-socket-address 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 Luolapeikko
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Luolapeikko
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -13,9 +13,9 @@ npm i net-socket-address net-address @luolapeikko/result-option
13
13
  ```typescript
14
14
  const socketAddr = new SocketAddrV4({port: 6372});
15
15
  // or new SocketAddrV4({addr: Ipv4Addr.UNSPECIFIED, port: 6372});
16
- tcpServer.listen(socketAddr..asNodeListenerOptions(), () => {});
17
- udpSocket.bind(socketAddr, () => {});
18
- tcpServer.listen({...socketAddr.asNodeListenerOptions(), ipv6Only: true}, () => {});
16
+ tcpServer.listen(socketAddr.asNodeListener(), () => {});
17
+ udpSocket.bind(socketAddr.asNodeBind(), () => {});
18
+ tcpServer.listen({...socketAddr.asNodeListener(), ipv6Only: true}, () => {});
19
19
  ```
20
20
 
21
21
  ## Full [Documentation](https://luolapeikko.github.io/net-address-base/)
package/dist/index.cjs CHANGED
@@ -1,2 +1,2 @@
1
- Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require(`net-address`);var t=class{#e;port;address;family=`ipv4`;constructor({addr:t,port:n}){this.#e=t??e.Ipv4Addr.UNSPECIFIED,this.port=n,this.address=this.#e.toString()}asNodeListenerOptions(){return{port:this.port,host:this.address}}getRawAddress(){return this.#e}toString(){return`${this.address}:${this.port}`}},n=class{#e;port;family=`ipv6`;address;flowlabel;constructor({address:t,port:n,flowlabel:r}){this.#e=t??e.Ipv6Addr.UNSPECIFIED,this.port=n,this.flowlabel=r,this.address=this.#e.toString()}asNodeListenerOptions(){return{port:this.port,host:this.address}}getRawAddress(){return this.#e}toString(){return`${this.address}:${this.port}`}};exports.SocketAddrV4=t,exports.SocketAddrV6=n;
1
+ Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("net-address");var t=class{port;address;family=`ipv4`;constructor({addr:t,port:n}){this.address=t??e.Ipv4Addr.UNSPECIFIED,this.port=n}asNodeListener(){return{port:this.port,host:this.address.toString()}}asNodeBind(){return{port:this.port,address:this.address.toString()}}toString(){return`${this.address.toString()}:${this.port}`}},n=class{port;family=`ipv6`;address;flowlabel;constructor({address:t,port:n,flowlabel:r}){this.address=t??e.Ipv6Addr.UNSPECIFIED,this.port=n,this.flowlabel=r}asNodeListener(){return{port:this.port,host:this.address.toString()}}asNodeBind(){return{port:this.port,address:this.address.toString()}}toString(){return`[${this.address.toString()}]:${this.port}`}};exports.SocketAddrV4=t,exports.SocketAddrV6=n;
2
2
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","names":["#addr","Ipv4Addr","#addr","Ipv6Addr"],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"sourcesContent":["import {Ipv4Addr} from 'net-address';\n\n/**\n * Represents an IPv4 socket address, consisting of an IPv4 address and a port number.\n * @example\n * const socketAddr = new SocketAddrV4({port: 6372}); // new SocketAddrV4({addr: Ipv4Addr.UNSPECIFIED, port: 6372});\n * tcpServer.listen(socketAddr.asNodeListenerOptions(), () => {});\n * udpSocket.bind(socketAddr, () => {});\n * tcpServer.listen({...socketAddr.asNodeListenerOptions(), ipv6Only: true}, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV4 {\n\t#addr: Ipv4Addr;\n\tpublic readonly port: number;\n\tpublic readonly address: string;\n\tpublic readonly family = 'ipv4';\n\t/**\n\t * Creates a new `SocketAddrV4` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.addr - The IPv4 address. Defaults to {@link Ipv4Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t */\n\tpublic constructor({addr, port}: {addr?: Ipv4Addr; port: number}) {\n\t\tthis.#addr = addr ?? Ipv4Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t\tthis.address = this.#addr.toString();\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListenerOptions(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address,\n\t\t};\n\t}\n\n\t/**\n\t * Gets the raw `Ipv4Addr` instance representing the IP address of this socket address.\n\t * @returns Ipv4Addr instance of the socket address's IP address.\n\t * @since v0.0.1\n\t */\n\tpublic getRawAddress(): Ipv4Addr {\n\t\treturn this.#addr;\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"address:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `${this.address}:${this.port}`;\n\t}\n}\n","import {Ipv6Addr} from 'net-address';\n\n/**\n * Represents an IPv6 socket address, consisting of an IPv6 address, a port number, and an optional flow label.\n * @example\n * const anySocketAddress = new SocketAddrV6(6372); // new SocketAddrV6(Ipv6Addr.UNSPECIFIED, 6372);\n * tcpServer.listen(anySocketAddress.asNodeListenerOptions(), () => {});\n * udpSocket.bind(anySocketAddress, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV6 {\n\t#addr: Ipv6Addr;\n\tpublic readonly port: number;\n\tpublic readonly family = 'ipv6';\n\tpublic readonly address: string;\n\tpublic flowlabel?: number;\n\n\t/**\n\t * Creates a new `SocketAddrV6` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.address - The IPv6 address. Defaults to {@link Ipv6Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t * @param options.flowlabel - The flow label.\n\t */\n\tpublic constructor({address, port, flowlabel}: {address?: Ipv6Addr; port: number; flowlabel?: number}) {\n\t\tthis.#addr = address ?? Ipv6Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t\tthis.flowlabel = flowlabel;\n\t\tthis.address = this.#addr.toString();\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListenerOptions(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address,\n\t\t};\n\t}\n\n\t/**\n\t * Gets the raw `Ipv6Addr` instance representing the IP address of this socket address.\n\t * @returns Ipv6Addr instance of the socket address's IP address.\n\t * @since v0.0.1\n\t */\n\tpublic getRawAddress(): Ipv6Addr {\n\t\treturn this.#addr;\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"address:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `${this.address}:${this.port}`;\n\t}\n}\n"],"mappings":"gGAWA,IAAa,EAAb,KAA0B,CACzB,GACA,KACA,QACA,OAAyB,OAOzB,YAAmB,CAAC,OAAM,QAAwC,CACjE,MAAA,EAAa,GAAQC,EAAAA,SAAS,YAC9B,KAAK,KAAO,EACZ,KAAK,QAAU,MAAA,EAAW,UAAU,CAQrC,uBAA6D,CAC5D,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QACX,CAQF,eAAiC,CAChC,OAAO,MAAA,EAQR,UAA0B,CACzB,MAAO,GAAG,KAAK,QAAQ,GAAG,KAAK,SC7CpB,EAAb,KAA0B,CACzB,GACA,KACA,OAAyB,OACzB,QACA,UASA,YAAmB,CAAC,UAAS,OAAM,aAAoE,CACtG,MAAA,EAAa,GAAWE,EAAAA,SAAS,YACjC,KAAK,KAAO,EACZ,KAAK,UAAY,EACjB,KAAK,QAAU,MAAA,EAAW,UAAU,CAQrC,uBAA6D,CAC5D,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QACX,CAQF,eAAiC,CAChC,OAAO,MAAA,EAQR,UAA0B,CACzB,MAAO,GAAG,KAAK,QAAQ,GAAG,KAAK"}
1
+ {"version":3,"file":"index.cjs","names":["Ipv4Addr","Ipv6Addr"],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"sourcesContent":["import {Ipv4Addr} from 'net-address';\n\n/**\n * Represents an IPv4 socket address, consisting of an IPv4 address and a port number.\n * @example\n * const socketAddr = new SocketAddrV4({port: 6372}); // new SocketAddrV4({addr: Ipv4Addr.UNSPECIFIED, port: 6372});\n * tcpServer.listen(socketAddr.asNodeListenerOptions(), () => {});\n * udpSocket.bind(socketAddr.asNodeBindOptions(), () => {});\n * tcpServer.listen({...socketAddr.asNodeListenerOptions(), ipv6Only: true}, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV4 {\n\tpublic readonly port: number;\n\tpublic readonly address: Ipv4Addr;\n\tpublic readonly family = 'ipv4';\n\t/**\n\t * Creates a new `SocketAddrV4` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.addr - The IPv4 address. Defaults to {@link Ipv4Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t */\n\tpublic constructor({addr, port}: {addr?: Ipv4Addr; port: number}) {\n\t\tthis.address = addr ?? Ipv4Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListener(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.\n\t * @returns An object containing the `port` and `address` properties.\n\t * @since v0.1.0\n\t */\n\tpublic asNodeBind(): {port: number; address: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\taddress: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"address:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `${this.address.toString()}:${this.port}`;\n\t}\n}\n","import {Ipv6Addr} from 'net-address';\n\n/**\n * Represents an IPv6 socket address, consisting of an IPv6 address, a port number, and an optional flow label.\n * @example\n * const anySocketAddress = new SocketAddrV6(6372); // new SocketAddrV6(Ipv6Addr.UNSPECIFIED, 6372);\n * tcpServer.listen(anySocketAddress.asNodeListenerOptions(), () => {});\n * udpSocket.bind(anySocketAddress, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV6 {\n\tpublic readonly port: number;\n\tpublic readonly family = 'ipv6';\n\tpublic readonly address: Ipv6Addr;\n\tpublic flowlabel?: number;\n\n\t/**\n\t * Creates a new `SocketAddrV6` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.address - The IPv6 address. Defaults to {@link Ipv6Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t * @param options.flowlabel - The flow label.\n\t */\n\tpublic constructor({address, port, flowlabel}: {address?: Ipv6Addr; port: number; flowlabel?: number}) {\n\t\tthis.address = address ?? Ipv6Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t\tthis.flowlabel = flowlabel;\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListener(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.\n\t * @returns An object containing the `port` and `address` properties.\n\t * @since v0.1.0\n\t */\n\tpublic asNodeBind(): {port: number; address: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\taddress: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"[address]:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `[${this.address.toString()}]:${this.port}`;\n\t}\n}\n"],"mappings":"gGAWA,IAAa,EAAb,KAA0B,CACzB,KACA,QACA,OAAyB,OAOzB,YAAmB,CAAC,OAAM,QAAwC,CACjE,KAAK,QAAU,GAAQA,EAAAA,SAAS,YAChC,KAAK,KAAO,CACb,CAOA,gBAAsD,CACrD,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QAAQ,SAAS,CAC7B,CACD,CAOA,YAAqD,CACpD,MAAO,CACN,KAAM,KAAK,KACX,QAAS,KAAK,QAAQ,SAAS,CAChC,CACD,CAOA,UAA0B,CACzB,MAAO,GAAG,KAAK,QAAQ,SAAS,EAAE,GAAG,KAAK,MAC3C,CACD,EChDa,EAAb,KAA0B,CACzB,KACA,OAAyB,OACzB,QACA,UASA,YAAmB,CAAC,UAAS,OAAM,aAAoE,CACtG,KAAK,QAAU,GAAWC,EAAAA,SAAS,YACnC,KAAK,KAAO,EACZ,KAAK,UAAY,CAClB,CAOA,gBAAsD,CACrD,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QAAQ,SAAS,CAC7B,CACD,CAOA,YAAqD,CACpD,MAAO,CACN,KAAM,KAAK,KACX,QAAS,KAAK,QAAQ,SAAS,CAChC,CACD,CAOA,UAA0B,CACzB,MAAO,IAAI,KAAK,QAAQ,SAAS,EAAE,IAAI,KAAK,MAC7C,CACD"}
package/dist/index.d.cts CHANGED
@@ -6,14 +6,13 @@ import { Ipv4Addr, Ipv6Addr } from "net-address";
6
6
  * @example
7
7
  * const socketAddr = new SocketAddrV4({port: 6372}); // new SocketAddrV4({addr: Ipv4Addr.UNSPECIFIED, port: 6372});
8
8
  * tcpServer.listen(socketAddr.asNodeListenerOptions(), () => {});
9
- * udpSocket.bind(socketAddr, () => {});
9
+ * udpSocket.bind(socketAddr.asNodeBindOptions(), () => {});
10
10
  * tcpServer.listen({...socketAddr.asNodeListenerOptions(), ipv6Only: true}, () => {});
11
11
  * @since v0.0.1
12
12
  */
13
13
  declare class SocketAddrV4 {
14
- #private;
15
14
  readonly port: number;
16
- readonly address: string;
15
+ readonly address: Ipv4Addr;
17
16
  readonly family = "ipv4";
18
17
  /**
19
18
  * Creates a new `SocketAddrV4` instance.
@@ -33,16 +32,19 @@ declare class SocketAddrV4 {
33
32
  * @returns An object containing the `port` and `host` properties.
34
33
  * @since v0.0.1
35
34
  */
36
- asNodeListenerOptions(): {
35
+ asNodeListener(): {
37
36
  port: number;
38
37
  host: string;
39
38
  };
40
39
  /**
41
- * Gets the raw `Ipv4Addr` instance representing the IP address of this socket address.
42
- * @returns Ipv4Addr instance of the socket address's IP address.
43
- * @since v0.0.1
40
+ * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.
41
+ * @returns An object containing the `port` and `address` properties.
42
+ * @since v0.1.0
44
43
  */
45
- getRawAddress(): Ipv4Addr;
44
+ asNodeBind(): {
45
+ port: number;
46
+ address: string;
47
+ };
46
48
  /**
47
49
  * Returns a string representation of this socket address.
48
50
  * @returns The string representation in the format "address:port".
@@ -61,10 +63,9 @@ declare class SocketAddrV4 {
61
63
  * @since v0.0.1
62
64
  */
63
65
  declare class SocketAddrV6 {
64
- #private;
65
66
  readonly port: number;
66
67
  readonly family = "ipv6";
67
- readonly address: string;
68
+ readonly address: Ipv6Addr;
68
69
  flowlabel?: number;
69
70
  /**
70
71
  * Creates a new `SocketAddrV6` instance.
@@ -87,19 +88,22 @@ declare class SocketAddrV6 {
87
88
  * @returns An object containing the `port` and `host` properties.
88
89
  * @since v0.0.1
89
90
  */
90
- asNodeListenerOptions(): {
91
+ asNodeListener(): {
91
92
  port: number;
92
93
  host: string;
93
94
  };
94
95
  /**
95
- * Gets the raw `Ipv6Addr` instance representing the IP address of this socket address.
96
- * @returns Ipv6Addr instance of the socket address's IP address.
97
- * @since v0.0.1
96
+ * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.
97
+ * @returns An object containing the `port` and `address` properties.
98
+ * @since v0.1.0
98
99
  */
99
- getRawAddress(): Ipv6Addr;
100
+ asNodeBind(): {
101
+ port: number;
102
+ address: string;
103
+ };
100
104
  /**
101
105
  * Returns a string representation of this socket address.
102
- * @returns The string representation in the format "address:port".
106
+ * @returns The string representation in the format "[address]:port".
103
107
  * @since v0.0.1
104
108
  */
105
109
  toString(): string;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.cts","names":[],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"mappings":";;;;;AAWA;;;;;;;cAAa,YAAA;EAAA;WAEI,IAAA;EAAA,SACA,OAAA;EAAA,SACA,MAAA;;;;;;;EAOhB,WAAA,CAAA;IAAoB,IAAA;IAAM;EAAA;IAAQ,IAAA,GAAO,QAAA;IAAU,IAAA;EAAA;;;;;;EAWnD,qBAAA,CAAA;IAAiC,IAAA;IAAc,IAAA;EAAA;;ACvBhD;;;;EDmCC,aAAA,CAAA,GAAwB,QAAA;;;;;;EASxB,QAAA,CAAA;AAAA;;;;;AA3CD;;;;;;cCDa,YAAA;EAAA;WAEI,IAAA;EAAA,SACA,MAAA;EAAA,SACA,OAAA;EAChB,SAAA;;;;;;;;EASA,WAAA,CAAA;IAAoB,OAAA;IAAS,IAAA;IAAM;EAAA;IAAa,OAAA,GAAU,QAAA;IAAU,IAAA;IAAc,SAAA;EAAA;;;;;;EAYlF,qBAAA,CAAA;IAAiC,IAAA;IAAc,IAAA;EAAA;EA1BnC;;;;;EAsCZ,aAAA,CAAA,GAAwB,QAAA;;;;;;EASxB,QAAA,CAAA;AAAA"}
1
+ {"version":3,"file":"index.d.cts","names":[],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"mappings":";;;;;AAWA;;;;;;;cAAa,YAAA;EAAA,SACI,IAAA;EAAA,SACA,OAAA,EAAS,QAAA;EAAA,SACT,MAAA;;;;;;;EAOhB,WAAA;IAAoB,IAAA;IAAM;EAAA;IAAQ,IAAA,GAAO,QAAA;IAAU,IAAA;EAAA;;;;;;EAUnD,cAAA;IAA0B,IAAA;IAAc,IAAA;EAAA;;;;ACrBzC;;EDiCC,UAAA;IAAsB,IAAA;IAAc,OAAA;EAAA;;;;;;EAYpC,QAAA;AAAA;;;;;AA5CD;;;;;;cCDa,YAAA;EAAA,SACI,IAAA;EAAA,SACA,MAAA;EAAA,SACA,OAAA,EAAS,QAAA;EACzB,SAAA;;;;;;;;EASA,WAAA;IAAoB,OAAA;IAAS,IAAA;IAAM;EAAA;IAAa,OAAA,GAAU,QAAA;IAAU,IAAA;IAAc,SAAA;EAAA;;;;;;EAWlF,cAAA;IAA0B,IAAA;IAAc,IAAA;EAAA;;AAxBzC;;;;EAoCC,UAAA;IAAsB,IAAA;IAAc,OAAA;EAAA;EAvBsB;;;;;EAmC1D,QAAA;AAAA"}
package/dist/index.d.mts CHANGED
@@ -6,14 +6,13 @@ import { Ipv4Addr, Ipv6Addr } from "net-address";
6
6
  * @example
7
7
  * const socketAddr = new SocketAddrV4({port: 6372}); // new SocketAddrV4({addr: Ipv4Addr.UNSPECIFIED, port: 6372});
8
8
  * tcpServer.listen(socketAddr.asNodeListenerOptions(), () => {});
9
- * udpSocket.bind(socketAddr, () => {});
9
+ * udpSocket.bind(socketAddr.asNodeBindOptions(), () => {});
10
10
  * tcpServer.listen({...socketAddr.asNodeListenerOptions(), ipv6Only: true}, () => {});
11
11
  * @since v0.0.1
12
12
  */
13
13
  declare class SocketAddrV4 {
14
- #private;
15
14
  readonly port: number;
16
- readonly address: string;
15
+ readonly address: Ipv4Addr;
17
16
  readonly family = "ipv4";
18
17
  /**
19
18
  * Creates a new `SocketAddrV4` instance.
@@ -33,16 +32,19 @@ declare class SocketAddrV4 {
33
32
  * @returns An object containing the `port` and `host` properties.
34
33
  * @since v0.0.1
35
34
  */
36
- asNodeListenerOptions(): {
35
+ asNodeListener(): {
37
36
  port: number;
38
37
  host: string;
39
38
  };
40
39
  /**
41
- * Gets the raw `Ipv4Addr` instance representing the IP address of this socket address.
42
- * @returns Ipv4Addr instance of the socket address's IP address.
43
- * @since v0.0.1
40
+ * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.
41
+ * @returns An object containing the `port` and `address` properties.
42
+ * @since v0.1.0
44
43
  */
45
- getRawAddress(): Ipv4Addr;
44
+ asNodeBind(): {
45
+ port: number;
46
+ address: string;
47
+ };
46
48
  /**
47
49
  * Returns a string representation of this socket address.
48
50
  * @returns The string representation in the format "address:port".
@@ -61,10 +63,9 @@ declare class SocketAddrV4 {
61
63
  * @since v0.0.1
62
64
  */
63
65
  declare class SocketAddrV6 {
64
- #private;
65
66
  readonly port: number;
66
67
  readonly family = "ipv6";
67
- readonly address: string;
68
+ readonly address: Ipv6Addr;
68
69
  flowlabel?: number;
69
70
  /**
70
71
  * Creates a new `SocketAddrV6` instance.
@@ -87,19 +88,22 @@ declare class SocketAddrV6 {
87
88
  * @returns An object containing the `port` and `host` properties.
88
89
  * @since v0.0.1
89
90
  */
90
- asNodeListenerOptions(): {
91
+ asNodeListener(): {
91
92
  port: number;
92
93
  host: string;
93
94
  };
94
95
  /**
95
- * Gets the raw `Ipv6Addr` instance representing the IP address of this socket address.
96
- * @returns Ipv6Addr instance of the socket address's IP address.
97
- * @since v0.0.1
96
+ * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.
97
+ * @returns An object containing the `port` and `address` properties.
98
+ * @since v0.1.0
98
99
  */
99
- getRawAddress(): Ipv6Addr;
100
+ asNodeBind(): {
101
+ port: number;
102
+ address: string;
103
+ };
100
104
  /**
101
105
  * Returns a string representation of this socket address.
102
- * @returns The string representation in the format "address:port".
106
+ * @returns The string representation in the format "[address]:port".
103
107
  * @since v0.0.1
104
108
  */
105
109
  toString(): string;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","names":[],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"mappings":";;;;;AAWA;;;;;;;cAAa,YAAA;EAAA;WAEI,IAAA;EAAA,SACA,OAAA;EAAA,SACA,MAAA;;;;;;;EAOhB,WAAA,CAAA;IAAoB,IAAA;IAAM;EAAA;IAAQ,IAAA,GAAO,QAAA;IAAU,IAAA;EAAA;;;;;;EAWnD,qBAAA,CAAA;IAAiC,IAAA;IAAc,IAAA;EAAA;;ACvBhD;;;;EDmCC,aAAA,CAAA,GAAwB,QAAA;;;;;;EASxB,QAAA,CAAA;AAAA;;;;;AA3CD;;;;;;cCDa,YAAA;EAAA;WAEI,IAAA;EAAA,SACA,MAAA;EAAA,SACA,OAAA;EAChB,SAAA;;;;;;;;EASA,WAAA,CAAA;IAAoB,OAAA;IAAS,IAAA;IAAM;EAAA;IAAa,OAAA,GAAU,QAAA;IAAU,IAAA;IAAc,SAAA;EAAA;;;;;;EAYlF,qBAAA,CAAA;IAAiC,IAAA;IAAc,IAAA;EAAA;EA1BnC;;;;;EAsCZ,aAAA,CAAA,GAAwB,QAAA;;;;;;EASxB,QAAA,CAAA;AAAA"}
1
+ {"version":3,"file":"index.d.mts","names":[],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"mappings":";;;;;AAWA;;;;;;;cAAa,YAAA;EAAA,SACI,IAAA;EAAA,SACA,OAAA,EAAS,QAAA;EAAA,SACT,MAAA;;;;;;;EAOhB,WAAA;IAAoB,IAAA;IAAM;EAAA;IAAQ,IAAA,GAAO,QAAA;IAAU,IAAA;EAAA;;;;;;EAUnD,cAAA;IAA0B,IAAA;IAAc,IAAA;EAAA;;;;ACrBzC;;EDiCC,UAAA;IAAsB,IAAA;IAAc,OAAA;EAAA;;;;;;EAYpC,QAAA;AAAA;;;;;AA5CD;;;;;;cCDa,YAAA;EAAA,SACI,IAAA;EAAA,SACA,MAAA;EAAA,SACA,OAAA,EAAS,QAAA;EACzB,SAAA;;;;;;;;EASA,WAAA;IAAoB,OAAA;IAAS,IAAA;IAAM;EAAA;IAAa,OAAA,GAAU,QAAA;IAAU,IAAA;IAAc,SAAA;EAAA;;;;;;EAWlF,cAAA;IAA0B,IAAA;IAAc,IAAA;EAAA;;AAxBzC;;;;EAoCC,UAAA;IAAsB,IAAA;IAAc,OAAA;EAAA;EAvBsB;;;;;EAmC1D,QAAA;AAAA"}
package/dist/index.mjs CHANGED
@@ -1,2 +1,2 @@
1
- import{Ipv4Addr as e,Ipv6Addr as t}from"net-address";var n=class{#e;port;address;family=`ipv4`;constructor({addr:t,port:n}){this.#e=t??e.UNSPECIFIED,this.port=n,this.address=this.#e.toString()}asNodeListenerOptions(){return{port:this.port,host:this.address}}getRawAddress(){return this.#e}toString(){return`${this.address}:${this.port}`}},r=class{#e;port;family=`ipv6`;address;flowlabel;constructor({address:e,port:n,flowlabel:r}){this.#e=e??t.UNSPECIFIED,this.port=n,this.flowlabel=r,this.address=this.#e.toString()}asNodeListenerOptions(){return{port:this.port,host:this.address}}getRawAddress(){return this.#e}toString(){return`${this.address}:${this.port}`}};export{n as SocketAddrV4,r as SocketAddrV6};
1
+ import{Ipv4Addr as e,Ipv6Addr as t}from"net-address";var n=class{port;address;family=`ipv4`;constructor({addr:t,port:n}){this.address=t??e.UNSPECIFIED,this.port=n}asNodeListener(){return{port:this.port,host:this.address.toString()}}asNodeBind(){return{port:this.port,address:this.address.toString()}}toString(){return`${this.address.toString()}:${this.port}`}},r=class{port;family=`ipv6`;address;flowlabel;constructor({address:e,port:n,flowlabel:r}){this.address=e??t.UNSPECIFIED,this.port=n,this.flowlabel=r}asNodeListener(){return{port:this.port,host:this.address.toString()}}asNodeBind(){return{port:this.port,address:this.address.toString()}}toString(){return`[${this.address.toString()}]:${this.port}`}};export{n as SocketAddrV4,r as SocketAddrV6};
2
2
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":["#addr","#addr"],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"sourcesContent":["import {Ipv4Addr} from 'net-address';\n\n/**\n * Represents an IPv4 socket address, consisting of an IPv4 address and a port number.\n * @example\n * const socketAddr = new SocketAddrV4({port: 6372}); // new SocketAddrV4({addr: Ipv4Addr.UNSPECIFIED, port: 6372});\n * tcpServer.listen(socketAddr.asNodeListenerOptions(), () => {});\n * udpSocket.bind(socketAddr, () => {});\n * tcpServer.listen({...socketAddr.asNodeListenerOptions(), ipv6Only: true}, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV4 {\n\t#addr: Ipv4Addr;\n\tpublic readonly port: number;\n\tpublic readonly address: string;\n\tpublic readonly family = 'ipv4';\n\t/**\n\t * Creates a new `SocketAddrV4` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.addr - The IPv4 address. Defaults to {@link Ipv4Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t */\n\tpublic constructor({addr, port}: {addr?: Ipv4Addr; port: number}) {\n\t\tthis.#addr = addr ?? Ipv4Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t\tthis.address = this.#addr.toString();\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListenerOptions(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address,\n\t\t};\n\t}\n\n\t/**\n\t * Gets the raw `Ipv4Addr` instance representing the IP address of this socket address.\n\t * @returns Ipv4Addr instance of the socket address's IP address.\n\t * @since v0.0.1\n\t */\n\tpublic getRawAddress(): Ipv4Addr {\n\t\treturn this.#addr;\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"address:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `${this.address}:${this.port}`;\n\t}\n}\n","import {Ipv6Addr} from 'net-address';\n\n/**\n * Represents an IPv6 socket address, consisting of an IPv6 address, a port number, and an optional flow label.\n * @example\n * const anySocketAddress = new SocketAddrV6(6372); // new SocketAddrV6(Ipv6Addr.UNSPECIFIED, 6372);\n * tcpServer.listen(anySocketAddress.asNodeListenerOptions(), () => {});\n * udpSocket.bind(anySocketAddress, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV6 {\n\t#addr: Ipv6Addr;\n\tpublic readonly port: number;\n\tpublic readonly family = 'ipv6';\n\tpublic readonly address: string;\n\tpublic flowlabel?: number;\n\n\t/**\n\t * Creates a new `SocketAddrV6` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.address - The IPv6 address. Defaults to {@link Ipv6Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t * @param options.flowlabel - The flow label.\n\t */\n\tpublic constructor({address, port, flowlabel}: {address?: Ipv6Addr; port: number; flowlabel?: number}) {\n\t\tthis.#addr = address ?? Ipv6Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t\tthis.flowlabel = flowlabel;\n\t\tthis.address = this.#addr.toString();\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListenerOptions(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address,\n\t\t};\n\t}\n\n\t/**\n\t * Gets the raw `Ipv6Addr` instance representing the IP address of this socket address.\n\t * @returns Ipv6Addr instance of the socket address's IP address.\n\t * @since v0.0.1\n\t */\n\tpublic getRawAddress(): Ipv6Addr {\n\t\treturn this.#addr;\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"address:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `${this.address}:${this.port}`;\n\t}\n}\n"],"mappings":"qDAWA,IAAa,EAAb,KAA0B,CACzB,GACA,KACA,QACA,OAAyB,OAOzB,YAAmB,CAAC,OAAM,QAAwC,CACjE,MAAA,EAAa,GAAQ,EAAS,YAC9B,KAAK,KAAO,EACZ,KAAK,QAAU,MAAA,EAAW,UAAU,CAQrC,uBAA6D,CAC5D,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QACX,CAQF,eAAiC,CAChC,OAAO,MAAA,EAQR,UAA0B,CACzB,MAAO,GAAG,KAAK,QAAQ,GAAG,KAAK,SC7CpB,EAAb,KAA0B,CACzB,GACA,KACA,OAAyB,OACzB,QACA,UASA,YAAmB,CAAC,UAAS,OAAM,aAAoE,CACtG,MAAA,EAAa,GAAW,EAAS,YACjC,KAAK,KAAO,EACZ,KAAK,UAAY,EACjB,KAAK,QAAU,MAAA,EAAW,UAAU,CAQrC,uBAA6D,CAC5D,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QACX,CAQF,eAAiC,CAChC,OAAO,MAAA,EAQR,UAA0B,CACzB,MAAO,GAAG,KAAK,QAAQ,GAAG,KAAK"}
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../src/SocketAddrV4.ts","../src/SocketAddrV6.ts"],"sourcesContent":["import {Ipv4Addr} from 'net-address';\n\n/**\n * Represents an IPv4 socket address, consisting of an IPv4 address and a port number.\n * @example\n * const socketAddr = new SocketAddrV4({port: 6372}); // new SocketAddrV4({addr: Ipv4Addr.UNSPECIFIED, port: 6372});\n * tcpServer.listen(socketAddr.asNodeListenerOptions(), () => {});\n * udpSocket.bind(socketAddr.asNodeBindOptions(), () => {});\n * tcpServer.listen({...socketAddr.asNodeListenerOptions(), ipv6Only: true}, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV4 {\n\tpublic readonly port: number;\n\tpublic readonly address: Ipv4Addr;\n\tpublic readonly family = 'ipv4';\n\t/**\n\t * Creates a new `SocketAddrV4` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.addr - The IPv4 address. Defaults to {@link Ipv4Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t */\n\tpublic constructor({addr, port}: {addr?: Ipv4Addr; port: number}) {\n\t\tthis.address = addr ?? Ipv4Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListener(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.\n\t * @returns An object containing the `port` and `address` properties.\n\t * @since v0.1.0\n\t */\n\tpublic asNodeBind(): {port: number; address: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\taddress: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"address:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `${this.address.toString()}:${this.port}`;\n\t}\n}\n","import {Ipv6Addr} from 'net-address';\n\n/**\n * Represents an IPv6 socket address, consisting of an IPv6 address, a port number, and an optional flow label.\n * @example\n * const anySocketAddress = new SocketAddrV6(6372); // new SocketAddrV6(Ipv6Addr.UNSPECIFIED, 6372);\n * tcpServer.listen(anySocketAddress.asNodeListenerOptions(), () => {});\n * udpSocket.bind(anySocketAddress, () => {});\n * @since v0.0.1\n */\nexport class SocketAddrV6 {\n\tpublic readonly port: number;\n\tpublic readonly family = 'ipv6';\n\tpublic readonly address: Ipv6Addr;\n\tpublic flowlabel?: number;\n\n\t/**\n\t * Creates a new `SocketAddrV6` instance.\n\t * @param options - The options for creating the socket address.\n\t * @param options.address - The IPv6 address. Defaults to {@link Ipv6Addr.UNSPECIFIED}.\n\t * @param options.port - The port number.\n\t * @param options.flowlabel - The flow label.\n\t */\n\tpublic constructor({address, port, flowlabel}: {address?: Ipv6Addr; port: number; flowlabel?: number}) {\n\t\tthis.address = address ?? Ipv6Addr.UNSPECIFIED;\n\t\tthis.port = port;\n\t\tthis.flowlabel = flowlabel;\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `net.Server.listen()` method.\n\t * @returns An object containing the `port` and `host` properties.\n\t * @since v0.0.1\n\t */\n\tpublic asNodeListener(): {port: number; host: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\thost: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns an object suitable for use as options in Node.js `dgram.Socket.bind()` method.\n\t * @returns An object containing the `port` and `address` properties.\n\t * @since v0.1.0\n\t */\n\tpublic asNodeBind(): {port: number; address: string} {\n\t\treturn {\n\t\t\tport: this.port,\n\t\t\taddress: this.address.toString(),\n\t\t};\n\t}\n\n\t/**\n\t * Returns a string representation of this socket address.\n\t * @returns The string representation in the format \"[address]:port\".\n\t * @since v0.0.1\n\t */\n\tpublic toString(): string {\n\t\treturn `[${this.address.toString()}]:${this.port}`;\n\t}\n}\n"],"mappings":"qDAWA,IAAa,EAAb,KAA0B,CACzB,KACA,QACA,OAAyB,OAOzB,YAAmB,CAAC,OAAM,QAAwC,CACjE,KAAK,QAAU,GAAQ,EAAS,YAChC,KAAK,KAAO,CACb,CAOA,gBAAsD,CACrD,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QAAQ,SAAS,CAC7B,CACD,CAOA,YAAqD,CACpD,MAAO,CACN,KAAM,KAAK,KACX,QAAS,KAAK,QAAQ,SAAS,CAChC,CACD,CAOA,UAA0B,CACzB,MAAO,GAAG,KAAK,QAAQ,SAAS,EAAE,GAAG,KAAK,MAC3C,CACD,EChDa,EAAb,KAA0B,CACzB,KACA,OAAyB,OACzB,QACA,UASA,YAAmB,CAAC,UAAS,OAAM,aAAoE,CACtG,KAAK,QAAU,GAAW,EAAS,YACnC,KAAK,KAAO,EACZ,KAAK,UAAY,CAClB,CAOA,gBAAsD,CACrD,MAAO,CACN,KAAM,KAAK,KACX,KAAM,KAAK,QAAQ,SAAS,CAC7B,CACD,CAOA,YAAqD,CACpD,MAAO,CACN,KAAM,KAAK,KACX,QAAS,KAAK,QAAQ,SAAS,CAChC,CACD,CAOA,UAA0B,CACzB,MAAO,IAAI,KAAK,QAAQ,SAAS,EAAE,IAAI,KAAK,MAC7C,CACD"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "net-socket-address",
3
- "version": "0.0.1",
3
+ "version": "0.1.0",
4
4
  "description": "Network socket address instances",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",