API referenceInterfaces
KysoqlConfig
Generated API reference for KysoqlConfig in @kysoql/codegen.
@kysoql/codegen / KysoqlConfig
Schema-generation settings. Authentication is resolved explicitly.
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
auth? | readonly | SalesforceAuthProvider | Obtain the Salesforce session used by the CLI. |
apiVersion? | readonly | string | Salesforce REST API version, without v. Applies to CLI generation only. |
objects? | readonly | readonly string[] | API names. Omit or use [] to include all queryable objects. |
fields? | readonly | Readonly<Record<string, ObjectFieldFilter>> | Per-object field rules. Omitted objects retain all described fields. |
output? | readonly | string | Override the generated file; relative paths resolve from this config file. |
schemaName? | readonly | string | Name of the generated TypeScript schema interface. |