# GenerateSchemaOptions (/docs/codegen/api/interfaces/GenerateSchemaOptions)



[@kysoql/codegen](/docs/codegen/api) / GenerateSchemaOptions

Options for generating a TypeScript Kysoql schema from Salesforce Describe
metadata.

## Properties [#properties]

| Property                                         | Modifier   | Type                                                                                                      | Description                                                                     |
| ------------------------------------------------ | ---------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| <a id="api-property-client" /> `client`          | `readonly` | [`SalesforceDescribeClient`](/docs/codegen/api/interfaces/SalesforceDescribeClient)                       | Describe client used to load Salesforce metadata.                               |
| <a id="api-property-output" /> `output`          | `readonly` | `string`                                                                                                  | Destination path for the generated TypeScript schema file.                      |
| <a id="api-property-objects" /> `objects?`       | `readonly` | readonly `string`\[]                                                                                      | Optional object API names to generate; omit to generate every queryable object. |
| <a id="api-property-fields" /> `fields?`         | `readonly` | `Readonly`\<`Record`\<`string`, [`ObjectFieldFilter`](/docs/codegen/api/type-aliases/ObjectFieldFilter)>> | Optional per-object field include/exclude rules.                                |
| <a id="api-property-schemaname" /> `schemaName?` | `readonly` | `string`                                                                                                  | Name of the generated TypeScript schema type.                                   |