> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modelence.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ConfigSchema

[API Reference](/api-reference/modelence/index/type-aliases/../../../index) / [modelence](/api-reference/modelence/index/type-aliases/../../index) / [index](/api-reference/modelence/index/type-aliases/../index) / ConfigSchema

> **ConfigSchema** = `object`

Defined in: [packages/modelence/src/config/types.ts:81](https://github.com/modelence/modelence/blob/f614ecc6811cdda9670d612872c8ff49a49c5e28/packages/modelence/src/config/types.ts#L81)

Defines the configuration schema for a module. Each key becomes a namespaced
config value accessible via `getConfig('moduleName.key')`.

## Example

```ts theme={null}
import { Module } from 'modelence/server';

export default new Module('payments', {
  configSchema: {
    apiKey: {
      type: 'secret',
      default: '',
      isPublic: false,
    },
    currency: {
      type: 'string',
      default: 'USD',
      isPublic: true,
    },
  },
});
```

## Index Signature

\[`key`: `string`]: `ConfigParams`\<[`ConfigType`](/api-reference/modelence/index/type-aliases/../../server/type-aliases/ConfigType), `boolean`>