Skip to main content

getRequiredVariables

client.contextAssembly.getRequiredVariables(data: GetRequiredVariablesRequest): Promise<string[]>

Retrieves required variables for a context assembly configuration.

Returns the list of variable names that must be provided when assembling context with the given configuration.

Parameters​

ParameterTypeRequiredDescription
dataGetRequiredVariablesRequestYesThe configuration to inspect for required variables

Returns​

Promise<string[]> — A promise that resolves to an array of variable name strings

Example​

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.contextAssembly.getRequiredVariables(/* GetRequiredVariablesRequest */);
console.log(result);