docs: include JSDoc in website API markers
This commit is contained in:
@@ -11,6 +11,13 @@ Named provider registry and capability-checked start surface.
|
||||
### ctx.subagents.registerProvider(provider)
|
||||
|
||||
```ts website-api
|
||||
/**
|
||||
* Register a provider under its name. Registration is effect-scoped and HMR
|
||||
* safe; removing a provider blocks new starts but does not revoke runs that
|
||||
* were already returned to their holders.
|
||||
* @param provider - the trusted provider implementation.
|
||||
* @returns the exact Cordis effect disposer.
|
||||
*/
|
||||
registerProvider(provider: SubagentProvider): () => void
|
||||
```
|
||||
|
||||
@@ -25,6 +32,11 @@ Register a provider under its name. Registration is effect-scoped and HMR safe;
|
||||
### ctx.subagents.getProvider(name)
|
||||
|
||||
```ts website-api
|
||||
/**
|
||||
* Look up a provider by name.
|
||||
* @param name - the provider name.
|
||||
* @returns the provider, or undefined when absent.
|
||||
*/
|
||||
getProvider(name: string): SubagentProvider | undefined
|
||||
```
|
||||
|
||||
@@ -39,6 +51,10 @@ Look up a provider by name.
|
||||
### ctx.subagents.list()
|
||||
|
||||
```ts website-api
|
||||
/**
|
||||
* List registered provider names in insertion order.
|
||||
* @returns the registered names.
|
||||
*/
|
||||
list(): string[]
|
||||
```
|
||||
|
||||
@@ -51,6 +67,15 @@ List registered provider names in insertion order.
|
||||
### ctx.subagents.start(name, request)
|
||||
|
||||
```ts website-api
|
||||
/**
|
||||
* Establish a ready child on the named provider. Capability and semantic
|
||||
* checks run before delegation. Provider ownership lasts until its promise
|
||||
* fulfills; a rejection therefore has no run for the caller to dispose and
|
||||
* emits no run lifecycle events.
|
||||
* @param name - the provider to use.
|
||||
* @param request - child prompt, parent, signal, and optional capabilities.
|
||||
* @returns the ready holder-owned run.
|
||||
*/
|
||||
async start(name: string, request: SubagentStartRequest): Promise<SubagentRun>
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user