Releases: ptcrealitylab/toolsocket
Releases · ptcrealitylab/toolsocket
2.1.2
2.1.1
Backwards compatibility with ToolSockets that lack parallel socket functionality
2.1.0
Merge pull request #9 from ptcrealitylab/parallelSockets Add support for creation of parallel sockets for large messages
2.0.1
patch version bump
2.0.0
Summary
- Confusing class hierarchy and parameters now flattened. No more
toolSocket.socket.socket
. Ever. - Many objects now get their own classes with proper documentation. No more
cbSub
,objBin
, orpackageData
. - Major classes now get their own files. No more bloated
index.js
. - Properties of
ToolSocketMessage
have getters/setters with legible names. No moreobjBin.o
orobjBin.f
. - JSDoc comments are present throughout with proper type annotations. No more wondering if 'binaryBuffer' is supposed to be an
Array
, aUint8Array
, or anArrayBuffer
. Schemas
are now built-up from individualSchemaValidators
, which cleans up validation logic.- Types here help prevent users from setting
maximum
for a validator when they meantmax-length
.
- Types here help prevent users from setting
- New Jest unit tests for new classes and integration tests between the client and server.
- Improved README now more concise and clear.
- Bumped package.json version to
2.0.0
.
New Classes
ToolSocketMessage
- The underlying WebSocket message format.
ToolSocketResponse
- An object that can be used to send a response to an incoming message.
MessageBundle
- An object that stores the message body (ToolSocketMessage
) and associated binary data if present.
BinaryBuffer
- A helper object used for processing incoming binary data that has been split across multiple messages.
Schema
- An object that offers utilities for parsing URLs/routes and validating object data formats.
SchemaValidator
- An object used in the construction of Schemas that defines how URL/route/object properties will be validated.
Version 1.0.0
Fix comma spacing