Kysoql
API referenceFunctions

loadSchema

Generated API reference for loadSchema in @kysoql/codegen.

@kysoql/codegen / loadSchema

function loadSchema(
   client,
   requestedObjects?,
   fields?
): Promise<readonly SalesforceObjectDescription[]>;

Loads and validates Salesforce object metadata, then applies configured field filters.

Parameters

ParameterType
clientSalesforceDescribeClient
requestedObjects?readonly string[]
fields?Readonly<Record<string, ObjectFieldFilter>>

Returns

Promise<readonly SalesforceObjectDescription[]>

On this page