RecipesAPI
Defined in: namespaces-core-plugins.ts:847
Author-declared multi-step plans (fn-101), dispatched through the fn-89 Invoker with caller-declared scopes.
fn-101
Properties
Section titled “Properties”triggers
Section titled “triggers”triggers:
object
Defined in: namespaces-core-plugins.ts:859
User-trigger contributor sub-bridge.
register()
Section titled “register()”register(
contribution):Promise<AnyJSONValue>
Registers a recipe trigger contribution.
Parameters
Section titled “Parameters”contribution
Section titled “contribution”Returns
Section titled “Returns”Promise<AnyJSONValue>
unregister()
Section titled “unregister()”unregister(
key):Promise<void>
Unregisters a trigger.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Methods
Section titled “Methods”register()
Section titled “register()”register(
spec):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:849
Registers a recipe definition. [recipes.register]
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<AnyJSONValue>
unregister()
Section titled “unregister()”unregister(
refOrHandle):Promise<void>
Defined in: namespaces-core-plugins.ts:851
Unregisters by ref or handle. [recipes.register]
Parameters
Section titled “Parameters”refOrHandle
Section titled “refOrHandle”Returns
Section titled “Returns”Promise<void>
run(
params):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:853
Runs a recipe. Returns a run handle. [recipes.run]
Parameters
Section titled “Parameters”params
Section titled “params”recipeRef
Section titled “recipeRef”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<AnyJSONValue>
list()
Section titled “list()”list(
params?):Promise<{recipes:AnyJSONValue[]; }>
Defined in: namespaces-core-plugins.ts:855
Lists visible recipes (no scope required).
Parameters
Section titled “Parameters”params?
Section titled “params?”filter?
Section titled “filter?”Returns
Section titled “Returns”Promise<{ recipes: AnyJSONValue[]; }>
get(
refOrParams):Promise<{recipe:AnyJSONValue; }>
Defined in: namespaces-core-plugins.ts:857
Gets a recipe definition, or null (no scope required).
Parameters
Section titled “Parameters”refOrParams
Section titled “refOrParams”Returns
Section titled “Returns”Promise<{ recipe: AnyJSONValue; }>