Node.js Public Interface Table Of Contents¶
Node.js contract table of contents | Language interface table of contents
Node.js contract table of contents · Common Spec
This directory fixes, per category, the public TypeScript
declarations the ZLink Framework's @zlink-systems/framework,
@zlink-systems/nestjs, and @zlink-systems/framework-locations-redis
package roots export. The same declaration isn't repeated across
multiple documents. Feature meaning and state transitions are owned by
the common spec, and this directory owns package export and signature
parity. The public contract of the HTTP client and Stream Connector is
owned by each package's separate spec.
| No. | Document | Scope |
|---|---|---|
| 01 | Foundation Types And Configuration | Global ID/ref, object role/capacity, Actor/Spot relocation adapter and explicit policy |
| 02 | Channel, Request, And Routing | Entry Spot actor messaging, Channel/Fanout/RouteMesh calls and handlers |
| 03 | Location, Host Lifecycle, And Observability | Operational queries, relocation mode/target version, runtime events, metrics, and tracing |
| 04 | Spot And Instance Spot | Spot lifecycle, User Spot manager, and the Instance cold-activation fluent call |
| 05 | Actor And Session Binding | Actor lifecycle, Actor call, and bound session |
| 06 | STREAM, Timer, And Worker | STREAM session, timer, and worker scheduling |
| 07 | NestJS Host Adapter | Module, DI token, decorator, and host builder |
| 08 | Location/Relocation Provider | Opaque atomic Location Store, immutable Relocation Store, and the official Redis provider |
The export name set of the deployment package and every file this table of contents points to must be the same in both directions. The binding package's service type, backend adapter, and runtime internal subpath aren't included in this export set. The Framework runtime internally uses the binding's public raw socket API. Verification scenarios are owned by the Node.js regression verification matrix. This directory only defines the public declaration and doesn't keep a progress table.
The valid range of public generation, revision, epoch, and sequence
ordinal is 1n..9223372036854775807n. Even though the TypeScript type
is bigint, this range isn't widened. On reaching the maximum value,
the framework treats it as terminal exhaustion, without wrap or value
reuse. 0n is only used when the relevant contract explicitly specifies
it to represent a not-yet-determined value.
Node.js contract table of contents | Language interface table of contents