@effect/docgen@4.1.0

Minor Changes

• #10087 472c469 Thanks @effect-bot! - Node.js 22.19.0 (required by undici 8) is now the minimum for @effect/platform-node, @effect/platform-node-shared, @effect/opentelemetry and @effect/docgen, up from 18.

  NodeSocket WebSocket clients now use Node's global WebSocket instead of ws, so client-only usage no longer bundles ws.

  Breaking: ws moved to a new NodeWS module.

  • NodeSocket.NodeWS and BunSocket.NodeWS are removed. Import NodeWS from @effect/platform-node or @effect/platform-node-shared (on Bun, import ws directly). Use NodeWS.WebSocket in place of NodeSocket.NodeWS.default.
  • NodeSocket.layerWebSocketConstructorWS is removed. Use NodeWS.layerWebSocketConstructor.

  Behaviour changes for clients that pass handshake headers, which previously used ws. Use NodeWS.layerWebSocketConstructor to keep the old behaviour:

  • Reads cannot be paused. Incoming frames are buffered without limit, and a configured highWaterMark fails the socket with a SocketReadError.
  • Connection errors are a generic ErrorEvent, so SocketOpenError causes lack the underlying error code.
  • The Socket.WebSocket service is a global WebSocket, so ws instanceof checks and ws-only methods such as terminate() and ping() no longer apply.
  • A custom Host header is ignored.
  • Outgoing messages are not compressed. Incoming permessage-deflate messages are still decompressed.
  • Connections use undici's global dispatcher instead of http.globalAgent / https.globalAgent.

• #8829 3d88452 Thanks @fubhy! - Add CommandLine to effect/process for quoting and joining command lines, and support Redacted arguments and env values in ChildProcess.

  Migration:

  • ChildProcess.make templates keep quoted words together and throw a CommandLineError for shell syntax such as |, $HOME or *. Quote such characters or pass them with ${}.
  • With the shell option, templates cannot contain ${} values and extra arguments fail with BadArgument. Pass the whole script as the command, built with CommandLine.join.
  • StandardCommand.args and env values can be Redacted strings.
  • ChildProcess.TemplateExpression and ChildProcess.TemplateExpressionItem are removed. Use the CommandLine types of the same name.

Patch Changes

• Updated dependencies [631d4f4, 7ea1ea2, a2ccc14, ed20129, 20795b9, a8e5e6c, c4d298d, fb5dbee, 8309b94, ac10e55, af23904, df8dce5, 0c24a8f, 468c6ee, 2d1fcd4, 8f23668, 3f8f359, fe6b748, 2a03584, 40e145e, 7217410, cf249fe, 4f0fad1, e75708c, 7890077, c4a00fc, f74db37, 069cf72, 9a07ebc, f40dc4e, fa516c6, ffd9237, 93895b9, 8938b19, e5a1479, 89e1e1e, eda0960, 65db606, 7c42335, cb21d14, 89e1e1e, c32eb78, be9895b, 472c469, 438ce72, 19d36b8, 26b4bfe, e19c611, f97711f, 4f16778, d2b6bc7, 8e668fe, ce9e999, 3d88452, 3c42058, 2ae4045, e853fa1, 6dc3f7c, 1513bbd, c065ed7, 1194a4c, 2cb498e, 89e5443, 2a9a425, e710bbb, b0d6e75, 32b3570, 9f93f4f, 27370c7]:
  • effect@4.1.0
  • @effect/platform-node@4.1.0