Interface: ActionMeta
For AI agents: see llms.txt for the complete documentation index. Markdown versions are available by adding .md to a page URL or requesting Accept: text/markdown.
server.ActionMeta
Extra context available in Convex action functions.
Methods
getFunctionMetadata
▸ getFunctionMetadata(): Promise<FunctionMetadata>
Metadata about the currently executing Convex function.
Returns
Promise<FunctionMetadata>
Defined in
getDeploymentMetadata
▸ getDeploymentMetadata(): Promise<DeploymentMetadata>
Metadata about the deployment this function is running on.
Returns
Promise<DeploymentMetadata>
Defined in
getRequestMetadata
▸ getRequestMetadata(): Promise<RequestMetadata>
Metadata about the HTTP request that triggered the current function execution.
ip and userAgent are null when the function was not triggered by an
HTTP request (e.g. scheduled jobs or cron jobs).
Functions called from within a function (i.e. using runMutation or
runAction) will have the same request metadata as the parent function.
Returns
Promise<RequestMetadata>