@pumpkin-plugins/config API / render / renderConfig

Function: renderConfig()

renderConfig<S>(schema, values, options?): string

Defined in: tools/config/src/render.ts:44

Renders a config file: every setting with its comment, in schema order.

Type Parameters

S

S extends ConfigSchema<Record<string, ConfigNode>>

Parameters

schema

S

The config schema.

values

ConfigValues<S>

The values to write, as returned by readConfig or defaultValues.

options?

RenderOptions = {}

Rendering options.

Returns

string

The TOML text, ending in a newline.