# generateSchema (/docs/codegen/api/functions/generateSchema)



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

```ts
function generateSchema(options): Promise<void>;
```

Loads Salesforce metadata and writes the rendered TypeScript schema to
disk.

## Parameters [#parameters]

| Parameter | Type                                                                          |
| --------- | ----------------------------------------------------------------------------- |
| `options` | [`GenerateSchemaOptions`](/docs/codegen/api/interfaces/GenerateSchemaOptions) |

## Returns [#returns]

`Promise`\<`void`>