@api.global/typedsocket 2.0.28 → 3.0.1
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/dist_ts/00_commitinfo_data.js +3 -3
- package/dist_ts/typedsocket.classes.typedsocket.js +1 -1
- package/npmextra.json +14 -3
- package/package.json +30 -22
- package/readme.hints.md +1 -0
- package/readme.md +148 -30
- package/ts/00_commitinfo_data.ts +2 -2
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@api.global/typedsocket',
|
|
6
|
-
version: '
|
|
7
|
-
description: '
|
|
6
|
+
version: '3.0.1',
|
|
7
|
+
description: 'A library for creating typed WebSocket connections, supporting bi-directional communication with type safety.'
|
|
8
8
|
};
|
|
9
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
9
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLCtHQUErRztDQUM3SCxDQUFBIn0=
|
|
@@ -147,4 +147,4 @@ export class TypedSocket {
|
|
|
147
147
|
await this.socketServerOrClient.stop();
|
|
148
148
|
}
|
|
149
149
|
}
|
|
150
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
150
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWRzb2NrZXQuY2xhc3Nlcy50eXBlZHNvY2tldC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3R5cGVkc29ja2V0LmNsYXNzZXMudHlwZWRzb2NrZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSwwQkFBMEIsQ0FBQztBQUVwRCxNQUFNLGNBQWMsR0FBRyxnQkFBZ0IsQ0FBQztBQUN4QyxNQUFNLGNBQWMsR0FBRyxnQkFBZ0IsQ0FBQztBQUl4QyxNQUFNLE9BQU8sV0FBVztJQUN0QixTQUFTO0lBQ1Q7OztPQUdHO0lBQ0ksTUFBTSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQzlCLGNBQWdELEVBQ2hELHFCQUEyQjtRQUUzQixNQUFNLGlCQUFpQixHQUFHLElBQUksT0FBTyxDQUFDLFdBQVcsQ0FBQyxXQUFXLENBQUM7WUFDNUQsS0FBSyxFQUFFLG1CQUFtQjtZQUMxQixJQUFJLEVBQUUsSUFBSTtTQUNYLENBQUMsQ0FBQztRQUNILElBQUkscUJBQXFCLEVBQUUsQ0FBQztZQUMxQixpQkFBaUIsQ0FBQyxpQkFBaUIsQ0FBQyxjQUFjLEVBQUUscUJBQXFCLENBQUMsQ0FBQztRQUM3RSxDQUFDO1FBRUQsaUJBQWlCLENBQUMsZUFBZSxDQUFDLEdBQUcsQ0FDbkMsSUFBSSxPQUFPLENBQUMsV0FBVyxDQUFDLGNBQWMsQ0FBQztZQUNyQyxRQUFRLEVBQUUsZ0JBQWdCO1lBQzFCLE9BQU8sRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFLG1CQUFtQixFQUFFLEVBQUU7Z0JBQzlDLE9BQU8sY0FBYyxDQUFDLG1CQUFtQixDQUFDLE9BQU8sQ0FBQyxDQUFDO1lBQ3JELENBQUM7U0FDRixDQUFDLENBQ0gsQ0FBQztRQUNGLE1BQU0sV0FBVyxHQUFHLElBQUksV0FBVyxDQUNqQyxRQUFRLEVBQ1IsY0FBYyxFQUNkLEtBQUssRUFDSCxPQUFVLEVBQ1YsbUJBQTBELEVBQzlDLEVBQUU7WUFDZCxJQUFJLENBQUMsbUJBQW1CLEVBQUUsQ0FBQztnQkFDekIsSUFBSSxDQUFDLGlCQUFpQixDQUFDLGlCQUFpQixDQUFDLFFBQVEsRUFBRSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsRUFBRSxDQUFDO29CQUNoRSxPQUFPLENBQUMsR0FBRyxDQUNULGtIQUFrSCxDQUNuSCxDQUFDO29CQUNGLG1CQUFtQixHQUFHLGlCQUFpQixDQUFDLGlCQUFpQixDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUMxRSxDQUFDO3FCQUFNLENBQUM7b0JBQ04sTUFBTSxJQUFJLEtBQUssQ0FDYixtR0FBbUcsQ0FDcEcsQ0FBQztnQkFDSixDQUFDO1lBQ0gsQ0FBQztZQUNELE1BQU0sUUFBUSxHQUFNLENBQUMsTUFBTSxpQkFBaUIsQ0FBQyxVQUFVLENBQ3JELGdCQUFnQixFQUNoQixPQUFPLEVBQ1AsbUJBQW1CLENBQ3BCLENBQVEsQ0FBQztZQUNWLE9BQU8sUUFBUSxDQUFDO1FBQ2xCLENBQUMsRUFDRCxpQkFBaUIsQ0FDbEIsQ0FBQztRQUNGLE1BQU0saUJBQWlCLENBQUMsS0FBSyxFQUFFLENBQUM7UUFFaEMsT0FBTyxXQUFXLENBQUM7SUFDckIsQ0FBQztJQUVNLE1BQU0sQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUM5QixjQUFnRCxFQUNoRCxZQUFvQixFQUNwQixRQUFRLEdBQUcsV0FBVztRQUV0QixNQUFNLE1BQU0sR0FBRyxJQUFJLE9BQU8sQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBRTVELE1BQU0sYUFBYSxHQUFrRDtZQUNuRSxLQUFLLEVBQUUsUUFBUTtZQUNmLElBQUksRUFBRSxNQUFNLENBQUMsSUFBSSxJQUFJLElBQUk7WUFDekIsR0FBRyxFQUFFLEdBQUcsTUFBTSxDQUFDLGFBQWEsQ0FBQyxRQUFRLEtBQUssTUFBTSxDQUFDLGFBQWEsQ0FBQyxRQUFRLEVBQUU7WUFDekUsYUFBYSxFQUFFLElBQUk7U0FDcEIsQ0FBQztRQUNGLE9BQU8sQ0FBQyxHQUFHLENBQUMsbURBQW1ELENBQUMsQ0FBQztRQUNqRSxPQUFPLENBQUMsR0FBRyxDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQzNCLE1BQU0saUJBQWlCLEdBQUcsSUFBSSxPQUFPLENBQUMsV0FBVyxDQUFDLGlCQUFpQixDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQ25GLGlCQUFpQixDQUFDLGlCQUFpQixDQUNqQyxJQUFJLE9BQU8sQ0FBQyxXQUFXLENBQUMsY0FBYyxDQUFDO1lBQ3JDLFFBQVEsRUFBRSxnQkFBZ0I7WUFDMUIsT0FBTyxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsRUFBRTtnQkFDOUMsT0FBTyxjQUFjLENBQUMsbUJBQW1CLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDckQsQ0FBQztTQUNGLENBQUMsQ0FDSCxDQUFDO1FBQ0YsTUFBTSxXQUFXLEdBQUcsSUFBSSxXQUFXLENBQ2pDLFFBQVEsRUFDUixjQUFjLEVBQ2QsS0FBSyxFQUEwRCxPQUFVLEVBQWMsRUFBRTtZQUN2RixNQUFNLFFBQVEsR0FBTSxpQkFBaUIsQ0FBQyxVQUFVLENBQUMsZ0JBQWdCLEVBQUUsT0FBTyxDQUFhLENBQUM7WUFDeEYsT0FBTyxRQUFRLENBQUM7UUFDbEIsQ0FBQyxFQUNELGlCQUFpQixDQUNsQixDQUFDO1FBQ0YsT0FBTyxDQUFDLEdBQUcsQ0FBQyxrREFBa0QsQ0FBQyxDQUFDO1FBQ2hFLE1BQU0sTUFBTSxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUMxQixNQUFNLGlCQUFpQixDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQ2xDLE9BQU8sQ0FBQyxHQUFHLENBQUMsa0RBQWtELElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxDQUFBO1FBRXpGLE9BQU8sV0FBVyxDQUFDO0lBQ3JCLENBQUM7YUFFYSwrQkFBMEIsR0FBRyxHQUFHLEVBQUU7UUFDOUMsTUFBTSxvQkFBb0IsR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUM1RyxPQUFPLG9CQUFvQixDQUFDO0lBQzlCLENBQUMsQ0FBQTtJQUtELElBQVcsWUFBWTtRQUNyQixPQUFPLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxZQUFZLENBQUM7SUFDaEQsQ0FBQztJQVNELFlBQ0UsT0FBeUIsRUFDekIsY0FBZ0QsRUFDaEQsYUFBK0MsRUFDL0MsdUJBQWdHO1FBRWhHLElBQUksQ0FBQyxJQUFJLEdBQUcsT0FBTyxDQUFDO1FBQ3BCLElBQUksQ0FBQyxXQUFXLEdBQUcsY0FBYyxDQUFDO1FBQ2xDLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO1FBQ2hDLElBQUksQ0FBQyxvQkFBb0IsR0FBRyx1QkFBdUIsQ0FBQztJQUN0RCxDQUFDO0lBRU0sTUFBTSxDQUNYLE9BQWtCLEVBQ2xCLFVBQXdCO1FBRXhCLElBQ0UsSUFBSSxDQUFDLElBQUksS0FBSyxRQUFRO1lBQ3RCLElBQUksQ0FBQyxvQkFBb0IsWUFBWSxPQUFPLENBQUMsV0FBVyxDQUFDLGlCQUFpQixFQUMxRSxDQUFDO1lBQ0QsSUFBSSxDQUFDLG9CQUFvQixDQUFDLGdCQUFnQixDQUFDLE1BQU0sQ0FBQztnQkFDaEQsRUFBRSxFQUFFLE9BQU87Z0JBQ1gsT0FBTyxFQUFFLFVBQVU7YUFDcEIsQ0FBQyxDQUFDO1FBQ0wsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLElBQUksS0FBSyxDQUFDLHNDQUFzQyxDQUFDLENBQUM7UUFDMUQsQ0FBQztJQUNILENBQUM7SUFFTSxrQkFBa0IsQ0FDdkIsVUFBdUIsRUFDdkIsZ0JBQXVEO1FBRXZELE1BQU0sWUFBWSxHQUFHLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQ3hELElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxXQUFXLENBQUM7WUFDbkMsVUFBVSxFQUFFLEtBQUssRUFBRSxjQUFjLEVBQUUsRUFBRTtnQkFDbkMsTUFBTSxNQUFNLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsRUFBRSxnQkFBZ0IsQ0FBQyxDQUFDO2dCQUN2RSxPQUFPLE1BQU0sQ0FBQztZQUNoQixDQUFDO1NBQ0YsQ0FBQyxFQUNGLFVBQVUsQ0FDWCxDQUFDO1FBQ0YsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSSxLQUFLLENBQUMsd0JBQXdCLENBQ25DLGdCQUEyRjtRQUUzRixJQUFJLElBQUksQ0FBQyxvQkFBb0IsWUFBWSxPQUFPLENBQUMsV0FBVyxDQUFDLFdBQVcsRUFBRSxDQUFDO1lBQ3pFLE1BQU0sZUFBZSxHQUEyQyxFQUFFLENBQUM7WUFDbkUsS0FBSyxNQUFNLGdCQUFnQixJQUFJLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLEVBQUUsRUFBRSxDQUFDO2dCQUN0RixJQUFJLE1BQU0sZ0JBQWdCLENBQUMsZ0JBQWdCLENBQUMsRUFBRSxDQUFDO29CQUM3QyxlQUFlLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLENBQUM7Z0JBQ3pDLENBQUM7WUFDSCxDQUFDO1lBQ0QsT0FBTyxlQUFlLENBQUM7UUFDekIsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLElBQUksS0FBSyxDQUFDLHdFQUF3RSxDQUFDLENBQUM7UUFDNUYsQ0FBQztJQUNILENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksS0FBSyxDQUFDLG9CQUFvQixDQUMvQixnQkFBMkY7UUFFM0YsTUFBTSxXQUFXLEdBQUcsTUFBTSxJQUFJLENBQUMsd0JBQXdCLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUMxRSxPQUFPLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN4QixDQUFDO0lBRU0sS0FBSyxDQUFDLDZCQUE2QixDQUV4QyxNQUFvQixFQUFFLFVBQTRCO1FBQ2xELE9BQU8sSUFBSSxDQUFDLHdCQUF3QixDQUFDLEtBQUssRUFBRSxtQkFBbUIsRUFBRSxFQUFFO1lBQ2pFLElBQUksTUFBZSxDQUFDO1lBQ3BCLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQztnQkFDaEIsTUFBTSxHQUFHLENBQUMsQ0FBQyxDQUFDLE1BQU0sbUJBQW1CLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDNUQsQ0FBQztpQkFBTSxDQUFDO2dCQUNOLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FDVCxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxDQUFDLE1BQU0sbUJBQW1CLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxDQUFDLEVBQUUsT0FBTyxDQUFDO29CQUNwRixPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsQ0FDeEMsQ0FBQztZQUNKLENBQUM7WUFDRCxPQUFPLE1BQU0sQ0FBQztRQUNoQixDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFTSxLQUFLLENBQUMseUJBQXlCLENBQ3BDLE1BQW9CLEVBQ3BCLFVBQTRCO1FBRTVCLE1BQU0sVUFBVSxHQUFHLE1BQU0sSUFBSSxDQUFDLDZCQUE2QixDQUFDLE1BQU0sRUFBRSxVQUFVLENBQUMsQ0FBQztRQUNoRixPQUFPLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN2QixDQUFDO0lBRU0sS0FBSyxDQUFDLElBQUk7UUFDZixNQUFNLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUN6QyxDQUFDIn0=
|
package/npmextra.json
CHANGED
|
@@ -2,17 +2,28 @@
|
|
|
2
2
|
"gitzone": {
|
|
3
3
|
"projectType": "npm",
|
|
4
4
|
"module": {
|
|
5
|
-
"githost": "
|
|
5
|
+
"githost": "code.foss.global",
|
|
6
6
|
"gitscope": "api.global",
|
|
7
7
|
"gitrepo": "typedsocket",
|
|
8
|
-
"description": "
|
|
8
|
+
"description": "A library for creating typed WebSocket connections, supporting bi-directional communication with type safety.",
|
|
9
9
|
"npmPackagename": "@api.global/typedsocket",
|
|
10
10
|
"license": "MIT",
|
|
11
|
-
"projectDomain": "api.global"
|
|
11
|
+
"projectDomain": "api.global",
|
|
12
|
+
"keywords": [
|
|
13
|
+
"WebSocket",
|
|
14
|
+
"Type Safety",
|
|
15
|
+
"Real-time Communication",
|
|
16
|
+
"Client-Server Architecture",
|
|
17
|
+
"TypeScript",
|
|
18
|
+
"Networking"
|
|
19
|
+
]
|
|
12
20
|
}
|
|
13
21
|
},
|
|
14
22
|
"npmci": {
|
|
15
23
|
"npmGlobalTools": [],
|
|
16
24
|
"npmAccessLevel": "public"
|
|
25
|
+
},
|
|
26
|
+
"tsdoc": {
|
|
27
|
+
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
17
28
|
}
|
|
18
29
|
}
|
package/package.json
CHANGED
|
@@ -1,35 +1,30 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@api.global/typedsocket",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.1",
|
|
4
4
|
"private": false,
|
|
5
|
-
"description": "
|
|
5
|
+
"description": "A library for creating typed WebSocket connections, supporting bi-directional communication with type safety.",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
7
7
|
"typings": "dist_ts/index.d.ts",
|
|
8
8
|
"type": "module",
|
|
9
9
|
"author": "Lossless GmbH",
|
|
10
10
|
"license": "MIT",
|
|
11
|
-
"scripts": {
|
|
12
|
-
"test": "(tstest test/ --web)",
|
|
13
|
-
"build": "(tsbuild --web --allowimplicitany)",
|
|
14
|
-
"buildDocs": "tsdoc"
|
|
15
|
-
},
|
|
16
11
|
"devDependencies": {
|
|
17
|
-
"@
|
|
18
|
-
"@
|
|
19
|
-
"@
|
|
20
|
-
"@
|
|
21
|
-
"@push.rocks/smartenv": "^5.0.
|
|
22
|
-
"@push.rocks/tapbundle": "^5.0.
|
|
23
|
-
"@types/node": "^20.
|
|
12
|
+
"@git.zone/tsbuild": "^2.1.66",
|
|
13
|
+
"@git.zone/tsbundle": "^2.0.8",
|
|
14
|
+
"@git.zone/tsrun": "^1.2.44",
|
|
15
|
+
"@git.zone/tstest": "^1.0.77",
|
|
16
|
+
"@push.rocks/smartenv": "^5.0.12",
|
|
17
|
+
"@push.rocks/tapbundle": "^5.0.23",
|
|
18
|
+
"@types/node": "^20.12.7"
|
|
24
19
|
},
|
|
25
20
|
"dependencies": {
|
|
26
|
-
"@api.global/typedrequest": "^3.0.
|
|
27
|
-
"@api.global/typedrequest-interfaces": "^3.0.
|
|
21
|
+
"@api.global/typedrequest": "^3.0.21",
|
|
22
|
+
"@api.global/typedrequest-interfaces": "^3.0.18",
|
|
28
23
|
"@push.rocks/isohash": "^2.0.0",
|
|
29
|
-
"@push.rocks/smartjson": "^5.0.
|
|
30
|
-
"@push.rocks/smartrx": "^3.0.
|
|
31
|
-
"@push.rocks/smartsocket": "^2.0.
|
|
32
|
-
"@push.rocks/smartstring": "^4.0.
|
|
24
|
+
"@push.rocks/smartjson": "^5.0.19",
|
|
25
|
+
"@push.rocks/smartrx": "^3.0.7",
|
|
26
|
+
"@push.rocks/smartsocket": "^2.0.25",
|
|
27
|
+
"@push.rocks/smartstring": "^4.0.15",
|
|
33
28
|
"@push.rocks/smarturl": "^3.0.5"
|
|
34
29
|
},
|
|
35
30
|
"browserslist": [
|
|
@@ -46,5 +41,18 @@
|
|
|
46
41
|
"cli.js",
|
|
47
42
|
"npmextra.json",
|
|
48
43
|
"readme.md"
|
|
49
|
-
]
|
|
50
|
-
|
|
44
|
+
],
|
|
45
|
+
"keywords": [
|
|
46
|
+
"WebSocket",
|
|
47
|
+
"Type Safety",
|
|
48
|
+
"Real-time Communication",
|
|
49
|
+
"Client-Server Architecture",
|
|
50
|
+
"TypeScript",
|
|
51
|
+
"Networking"
|
|
52
|
+
],
|
|
53
|
+
"scripts": {
|
|
54
|
+
"test": "(tstest test/ --web)",
|
|
55
|
+
"build": "(tsbuild --web --allowimplicitany --skiplibcheck)",
|
|
56
|
+
"buildDocs": "tsdoc"
|
|
57
|
+
}
|
|
58
|
+
}
|
package/readme.hints.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
package/readme.md
CHANGED
|
@@ -1,41 +1,159 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @api.global/typedsocket
|
|
2
2
|
a typedrequest extension supporting websockets
|
|
3
3
|
|
|
4
|
-
##
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
npm | [](https://lossless.cloud)
|
|
17
|
-
Snyk | [](https://lossless.cloud)
|
|
18
|
-
TypeScript Support | [](https://lossless.cloud)
|
|
19
|
-
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
20
|
-
Code Style | [](https://lossless.cloud)
|
|
21
|
-
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
22
|
-
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
23
|
-
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
4
|
+
## Install
|
|
5
|
+
To install `@api.global/typedsocket` in your project, run the following command using npm:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @api.global/typedsocket --save
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
For Yarn users:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
yarn add @api.global/typedsocket
|
|
15
|
+
```
|
|
24
16
|
|
|
25
17
|
## Usage
|
|
26
18
|
|
|
27
|
-
|
|
19
|
+
To utilize `@api.global/typedsocket` effectively, let's explore how to integrate it into a project with TypeScript. This guide provides comprehensive usage scenarios, highlighting all features of the module. `@api.global/typedsocket` extends the capabilities of `typedrequest` by integrating websocket support, allowing for real-time, bidirectional communication between a client and server.
|
|
20
|
+
|
|
21
|
+
### Getting Started
|
|
22
|
+
|
|
23
|
+
#### Prerequisites
|
|
24
|
+
|
|
25
|
+
Before diving into examples, ensure you have the following:
|
|
26
|
+
|
|
27
|
+
- A basic understanding of TypeScript and Node.js.
|
|
28
|
+
- An existing project set up with TypeScript.
|
|
29
|
+
- `@api.global/typedrequest` and its dependencies installed in your project.
|
|
30
|
+
|
|
31
|
+
#### Initialization
|
|
32
|
+
|
|
33
|
+
First, let's import the required modules and initialize our server and client instances.
|
|
34
|
+
|
|
35
|
+
**Server Side:**
|
|
36
|
+
|
|
37
|
+
Within your server-side code, import and set up `TypedSocket` to create a websocket server.
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { TypedSocket } from '@api.global/typedsocket';
|
|
41
|
+
import * as typedrequest from '@api.global/typedrequest';
|
|
42
|
+
|
|
43
|
+
// Initialize your TypedRouter
|
|
44
|
+
const typedRouter = new typedrequest.TypedRouter();
|
|
45
|
+
|
|
46
|
+
// Create the TypedSocket server
|
|
47
|
+
const server = await TypedSocket.createServer(typedRouter);
|
|
48
|
+
|
|
49
|
+
// Optionally, you can provide a smartexpressServerArg if you have an existing SmartExpress server
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
**Client Side:**
|
|
53
|
+
|
|
54
|
+
On the client side, initialize `TypedSocket` to connect to the websocket server.
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
import { TypedSocket } from '@api.global/typedsocket';
|
|
58
|
+
|
|
59
|
+
// Assuming server is at http://localhost:3000
|
|
60
|
+
const client = await TypedSocket.createClient(typedRouter, 'http://localhost:3000');
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Defining Typed Requests
|
|
64
|
+
|
|
65
|
+
`@api.global/typedsocket` leverages `typedrequest` for type-safe requests and responses. Here's how you can define and handle typed requests:
|
|
66
|
+
|
|
67
|
+
**Defining a Typed Request Interface:**
|
|
68
|
+
|
|
69
|
+
Define an interface for the request and its corresponding response.
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
interface ExampleRequest extends typedrequestInterfaces.ITypedRequest {
|
|
73
|
+
method: 'exampleMethod';
|
|
74
|
+
request: {
|
|
75
|
+
message: string;
|
|
76
|
+
};
|
|
77
|
+
response: {
|
|
78
|
+
reply: string;
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
**Handling Requests on the Server:**
|
|
84
|
+
|
|
85
|
+
Add a typed handler for the request in your `TypedRouter`.
|
|
86
|
+
|
|
87
|
+
```typescript
|
|
88
|
+
typedRouter.addTypedHandler<ExampleRequest>(
|
|
89
|
+
new typedrequest.TypedHandler('exampleMethod', async (requestData) => {
|
|
90
|
+
return {
|
|
91
|
+
reply: `Server received: ${requestData.message}`,
|
|
92
|
+
};
|
|
93
|
+
})
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Sending Requests from the Client
|
|
98
|
+
|
|
99
|
+
Use the client instance to send a request to the server and await a response.
|
|
100
|
+
|
|
101
|
+
```typescript
|
|
102
|
+
const exampleRequest = client.createTypedRequest<ExampleRequest>('exampleMethod');
|
|
103
|
+
const response = await exampleRequest.fire({
|
|
104
|
+
message: 'Hello from client!',
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
console.log(response.reply); // "Server received: Hello from client!"
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Advanced Usage
|
|
111
|
+
|
|
112
|
+
#### Tagging Connections
|
|
113
|
+
|
|
114
|
+
For more refined control, especially in scenarios with multiple clients, you can tag connections for targeted communication.
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
// Add a tag to a client
|
|
118
|
+
client.addTag('role', 'admin');
|
|
119
|
+
|
|
120
|
+
// On the server, find connections with the tag
|
|
121
|
+
const adminConnections = await server.findAllTargetConnectionsByTag('role', 'admin');
|
|
122
|
+
|
|
123
|
+
// Send a message to all admin connections
|
|
124
|
+
for (const adminConnection of adminConnections) {
|
|
125
|
+
const request = server.createTypedRequest<ExampleRequest>('exampleMethod', adminConnection);
|
|
126
|
+
await request.fire({
|
|
127
|
+
message: 'Message to admins',
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
#### Handling Reconnections
|
|
133
|
+
|
|
134
|
+
`TypedSocket` automatically attempts to reconnect in the event of connection loss. Ensure your server and client logic accounts for reconnection, especially for maintaining state or re-subscribing to necessary events.
|
|
135
|
+
|
|
136
|
+
### Conclusion
|
|
137
|
+
|
|
138
|
+
Implementing `@api.global/typedsocket` provides a type-safe, real-time communication layer for your TypeScript applications, extending the functionality of `typedrequest` into the realm of websockets. This guide covered initialization, defining typed requests, sending requests, and advanced usage patterns like tagging connections and handling reconnections.
|
|
139
|
+
|
|
140
|
+
Integrating `@api.global/typedsocket` into your project harnesses the power of websockets with the benefits of type safety and structured request/response patterns, enabling more reliable and maintainable real-time applications.
|
|
141
|
+
|
|
142
|
+
## License and Legal Information
|
|
143
|
+
|
|
144
|
+
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
145
|
+
|
|
146
|
+
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
28
147
|
|
|
29
|
-
|
|
148
|
+
### Trademarks
|
|
30
149
|
|
|
31
|
-
|
|
150
|
+
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
|
32
151
|
|
|
33
|
-
|
|
152
|
+
### Company Information
|
|
34
153
|
|
|
35
|
-
|
|
154
|
+
Task Venture Capital GmbH
|
|
155
|
+
Registered at District court Bremen HRB 35230 HB, Germany
|
|
36
156
|
|
|
37
|
-
For
|
|
157
|
+
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
|
38
158
|
|
|
39
|
-
|
|
40
|
-
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
|
41
|
-
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
159
|
+
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@api.global/typedsocket',
|
|
6
|
-
version: '
|
|
7
|
-
description: '
|
|
6
|
+
version: '3.0.1',
|
|
7
|
+
description: 'A library for creating typed WebSocket connections, supporting bi-directional communication with type safety.'
|
|
8
8
|
}
|