Skip to content

ZLink Framework Node.js — User Guide

The order to use ZLink Framework in a Node.js/NestJS environment. Chapters 03–17 share the same source across every language, and the example switches to Node.js code when you pick the .ts tab.

Order Document Content
1 1. Overview What it builds, the four integration axes, and the overall topology
2 2. Getting Started The package, the NestJS module, the handler, token injection
3 3. Core Concepts Channel · Spot · Actor · session · relocation
4 4. Backpressure How the system behaves when arrival outpaces processing, and the options that affect it
5 5. Channel Messaging Registering and calling request / send / pub-sub
6 6. Spot A dynamic state unit such as a room · stage · zone
7 7. Actor And Spot Actor hosting, membership, relocation
8 8. Session And Actor Binding Session ↔ Actor relay · binding · push
9 9. STREAM External-client real-time connections and the Stream Connector
10 10. Location Registering a location store, auto-connect, operational queries
11 11. Monitoring State snapshots · async iterables · diagnostics
12 12. Operations Runtime metrics, graceful drain, readiness
13 13. Key Type Usage Index Injection tokens, decorators, contract types
14 14. Picking A Sample How to choose which sample to look at first and run it
15 15. E2E Testing How to verify the whole system with the client
16 16. Options The option list, defaults, and when they can change
17 17. Where ZLink Fits Where it's used, the warning signs, and the boundary of the technology choice

The file number identifies the same chapter regardless of language. This table owns the reading order.

Chapters 01, 02, 11, 13, and 16 are written separately for Node.js because the install steps and surface names differ per language. Open each chapter directly from the links in the table above.