Encore.ts Streaming APIs

[marcuskohlberg]

We're exited to announce Encore v1.40, with support for building streaming APIs in Encore.ts

Streaming APIs

Streaming APIs are often used for building push notifications, collaborative tools, or continuous data processing.

In this release we've added support for creating streaming APIs in Encore.ts, enabling you to stream data both to and from your services using a type-safe interface on top of WebSockets.

Here's a simple example of a ping pong service:

interface Incoming {
  type: "ping";
}

interface Outgoing {
  type: "pong";
}

export const pingpongStream = api.streamInOut<Incoming, Outgoing>(
  { expose: true, path: "/ping" },
  async (stream) => {
    for await (const ping of stream) {
      await stream.send( { type: "pong" } );
    }
  }
);

See further examples and learn more in the docs.

Don't forget to update your CLI using: encore version update

New guide: Migrating from Express.js to Encore.ts for 9x performance

We recently wrote about our Encore.ts performance benchmarks, showing how Encore.ts is 9x more performant than Express.js.

Since many of you have asked, we've just published a more in-depth docs article comparing Encore.ts and Express.js. It also includes a migration guide, showing you how to migrate to Encore.ts to unlock improved performance.

📚 Check it out in the docs

Thanks to all our open source contributors

Encore now has over 60 contributors and we're closing in on 6000 stars!🌟
(If you haven't yet—why not star the project!)

We continue to be overwhelmed by your suggestions, bug reports, feedback, and pull requests.

New Contributors ❤️

• @agtabesh made their first contribution in fix: fix typo in app-structure.md #1301
• @omahs made their first contribution in docs: fix typos #1313
• @nnsW3 made their first contribution in docs: fix spelling issues #1330
• @IDispose made their first contribution in Update self-host.md #1302
• @tuckers-tech made their first contribution in TS Database Docs: Fix example database query for single row #1351

Tell us what you think

We love it when you share your Encore experiences with us and the world on Twitter, and when you ask questions on Discord.

Other improvements

• Add docs for TS logging by @ekerfelt in Add docs for TS logging #1280
• Add support for debugging TS apps by @ekerfelt in Add support for debugging TS apps #1281
• Add support for clearing traces from the local dashboard by @ekerfelt in Add support for clearing traces from the local dashboard #1282
• cli: Add lang selector in app init by @ekerfelt in cli: Add lang selector in app init #1284
• Use dlv for debugging if available by @ekerfelt in Use dlv for debugging if available #1283
• docs: Add docs for setting cookies by @ekerfelt in docs: Add docs for setting cookies #1285
• cli/cmd/encore: fix watch mode by @eandre in cli/cmd/encore: fix watch mode #1286
• fix: run cargo fmt by @fredr in fix: run cargo fmt #1287
• cli: fix brew update by @eandre in cli: fix brew update #1288
• Update go hello world example in readme by @fredr in Update go hello world example in readme #1289
• Refactor gateway in rust runtime by @fredr in Refactor gateway in rust runtime #1275
• runtimes/core: Remove temporary bind of gateway listener by @fredr in runtimes/core: Remove temporary bind of gateway listener #1291
• runtimes/core: handle lack of services and gateways by @eandre in runtimes/core: handle lack of services and gateways #1292
• runtimes/core: handle route conflicts in gateway by @eandre in runtimes/core: handle route conflicts in gateway #1293
• runtime/core: handle varchar in psql by @fredr in runtime/core: handle varchar in psql #1299
• fix: fix typo in app-structure.md by @agtabesh in fix: fix typo in app-structure.md #1301
• tsparser: go tag pairs should be separated by colon by @fredr in tsparser: go tag pairs should be separated by colon #1305
• clientgen/typescript: Add parentheses when lists element type is union by @fredr in clientgen/typescript: Add parentheses when lists element type is union #1304
• Update README.md by @marcuskohlberg in Update README.md #1310
• Log raw log line when json formatting fails by @fredr in Log raw log line when json formatting fails #1311
• Update pingora with windows support by @fredr in Update pingora with windows support #1303
• Cleanup unused cargo dependencies by @fredr in Cleanup unused cargo dependencies #1300
• Use pingoras error helpers by @fredr in Use pingoras error helpers #1312
• docs: fix typos by @omahs in docs: fix typos #1313
• clientgen: Add test from ts app by @fredr in clientgen: Add test from ts app #1306
• runtimes/core: handle worker mode by @eandre in runtimes/core: handle worker mode #1318
• Simplify codegen import paths by @fredr in Simplify codegen import paths #1319
• tsparser: add support for pnpm by @fredr in tsparser: add support for pnpm #1321
• tsparser: Search for package manager in workspace by @fredr in tsparser: Search for package manager in workspace #1322
• Update README.md by @marcuskohlberg in Update README.md #1323
• Update README.md by @marcuskohlberg in Update README.md #1324
• use framework wording in docs by @marcuskohlberg in use framework wording in docs #1325
• runtimes/go: bump pubsub library client by @eandre in runtimes/go: bump pubsub library client #1328
• runtimes/go: add adaptive gcp pubsub experiment by @eandre in runtimes/go: add adaptive gcp pubsub experiment #1329
• runtimes/js: bump braces by @fredr in runtimes/js: bump braces #1331
• docs: fix spelling issues by @nnsW3 in docs: fix spelling issues #1330
• runtimes/js: don't set worker mode in tests by @fredr in runtimes/js: don't set worker mode in tests #1332
• Update readme and related docs by @marcuskohlberg in Update readme and related docs #1335
• Update self-host.md by @IDispose in Update self-host.md #1302
• doc: add missing commas in runtime config example by @fredr in doc: add missing commas in runtime config example #1336
• Update README.md by @marcuskohlberg in Update README.md #1337
• runtimes/ts: don't throw when logging fails by @fredr in runtimes/ts: don't throw when logging fails #1338
• focus database troubleshooting docs by @marcuskohlberg in focus database troubleshooting docs #1339
• eject: make sure the go binary is executable on windows by @fredr in eject: make sure the go binary is executable on windows #1341
• Bump go-containerregistry by @fredr in Bump go-containerregistry #1342
• daemon: set a default log level in tests by @fredr in daemon: set a default log level in tests #1344
• gcp: reduce max pubsub streams to 90*conns by @eandre in gcp: reduce max pubsub streams to 90*conns #1345
• Cap concurrent local DB migratons to 50 to avoid hitting PSQL max conns by @ekerfelt in Cap concurrent local DB migratons to 50 to avoid hitting PSQL max conns #1334
• tsparser: error when auth handler have unsupported fields by @fredr in tsparser: error when auth handler have unsupported fields #1346
• runtimes/core: respect max retries for nsq by @eandre in runtimes/core: respect max retries for nsq #1347
• TS: Add support for streaming apis by @fredr in TS: Add support for streaming apis #1315
• fix panic when running e2e-tests by @fredr in fix panic when running e2e-tests #1350
• TS Database Docs: Fix example database query for single row by @tuckers-tech in TS Database Docs: Fix example database query for single row #1351
• Add express comparison docs by @simon-johansson in Add express comparison docs #1349
• Remove unused lockfiles by @fredr in Remove unused lockfiles #1297
• Add a link to the feature comparison section by @simon-johansson in Add a link to the feature comparison section #1352
• docs/ts: Add docs for new streaming apis by @fredr in docs/ts: Add docs for new streaming apis #1348

Full Changelog: v1.39.0...v1.40.0

---

This discussion was created from the release Encore.ts Streaming APIs.