| title | Runtime service APIs — the services object |
|---|---|
| navTitle | Runtime Service APIs |
| description | Reference entry for runtime `services.*` APIs used by flow nodes, hooks, and plugins. |
services.* is the accessor spelling, not necessarily the registry slot. The name
after services. is what this chapter documents each surface under; the string you pass
to ctx.getService(...) is the slot the implementation is registered by. They are the
same word for every service below — storage included, since the #9683 rename made
storage the canonical slot (its pre-rename spelling file-storage stays a deprecated
v17 alias — see services.storage).
Each page states its own slot in a Registry slot bullet;
scripts/check-runtime-services-index.mjs holds those to a real registerService call.
This chapter documents the runtime services.* APIs used in hook/action/flow/plugin code:
services.dataservices.sharingservices.auditservices.queueservices.emailservices.smsservices.pushservices.settingsservices.storage
| Level | Meaning |
|---|---|
stable |
Backward-compatible within a major version |
experimental |
API is available but may change in minor releases |
These two labels are the whole vocabulary. The same list is written out again as
Stability Labels, and
scripts/check-runtime-services-index.mjs holds both legends — and every page's
Stability bullet — to one definition, so a page cannot publish a label neither legend
defines. Adding a label means extending that definition in the same change that says what
it promises, in both places.
Each page links the canonical TypeScript source used to derive signatures.
- Data:
packages/client/src/index.ts - Sharing:
packages/spec/src/contracts/sharing-service.ts - Queue:
packages/spec/src/contracts/queue-service.ts - Email:
packages/spec/src/contracts/email-service.ts - SMS:
packages/spec/src/contracts/sms-service.ts - Push:
packages/services/service-push/src/push-service.ts - Storage:
packages/spec/src/contracts/storage-service.ts - Settings:
packages/services/service-settings/src/settings-service.ts - Audit:
packages/plugins/plugin-audit/src/auth-event-audit.ts
services.security is not on this list. The kernel registers a security service,
but it is an internal accessor rather than a documented runtime service, so this chapter
has no page for it. For access decisions read the
permissions guide — the one in-process call most readers need is
shown in Explain Access — and the interface an
implementation must provide, ISecurityService, is listed with the other
kernel contracts.