KysoqlAPI referenceInterfaces
GenerateSchemaOptions
Generated API reference for GenerateSchemaOptions in @kysoql/codegen.
@kysoql/codegen / GenerateSchemaOptions
Options for generating a TypeScript Kysoql schema from Salesforce Describe metadata.
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
client | readonly | SalesforceDescribeClient | Describe client used to load Salesforce metadata. |
output | readonly | string | Destination path for the generated TypeScript schema file. |
objects? | readonly | readonly string[] | Optional object API names to generate; omit to generate every queryable object. |
fields? | readonly | Readonly<Record<string, ObjectFieldFilter>> | Optional per-object field include/exclude rules. |
schemaName? | readonly | string | Name of the generated TypeScript schema type. |