Kysoql
API referenceInterfaces

KysoqlConfig

Generated API reference for KysoqlConfig in @kysoql/codegen.

@kysoql/codegen / KysoqlConfig

Schema-generation settings. Authentication is resolved explicitly.

Properties

PropertyModifierTypeDescription
auth?readonlySalesforceAuthProviderObtain the Salesforce session used by the CLI.
apiVersion?readonlystringSalesforce REST API version, without v. Applies to CLI generation only.
objects?readonlyreadonly string[]API names. Omit or use [] to include all queryable objects.
fields?readonlyReadonly<Record<string, ObjectFieldFilter>>Per-object field rules. Omitted objects retain all described fields.
output?readonlystringOverride the generated file; relative paths resolve from this config file.
schemaName?readonlystringName of the generated TypeScript schema interface.

On this page