ServiceDescriptor
Defined in: types.ts:318
Machine-readable description of a registered service, returned by ServiceHandle.describe()
and served by the transports’ opt-in GET /_services introspection endpoint.
Properties
Section titled “Properties”authRequired?
Section titled “authRequired?”
optionalauthRequired?:boolean
Defined in: types.ts:328
True when an auth hook (a hook carrying an authStrategy property, e.g. authenticate("jwt")) is registered in before.all.
capabilities?
Section titled “capabilities?”
optionalcapabilities?:RepositoryCapabilities
Defined in: types.ts:326
The underlying repository’s capabilities, when the service exposes them (see RepositoryService.describe()).
events
Section titled “events”events:
string[]
Defined in: types.ts:322
Event names this service emits: the standard created/updated/patched/removed set filtered by registered methods, plus custom ServiceOptions.events.
methods
Section titled “methods”methods:
string[]
Defined in: types.ts:320
path:
string
Defined in: types.ts:319
schema?
Section titled “schema?”
optionalschema?:unknown
Defined in: types.ts:324
The ServiceOptions.schema stored at registration (JSON Schema, e.g. via TypeBox).