@pumpkin-plugins/config API / describe / describeConfig

Function: describeConfig()

describeConfig(schema, file, renderOptions?): ConfigInfo

Defined in: tools/config/src/describe.ts:23

Describes a config file for the README generator: the file a fresh install gets and a table of every setting. Both come from the schema, so they can't drift from what the plugin reads.

Parameters

schema

ConfigSchema

The config schema.

file

string

The config file's name in the plugin's data folder.

renderOptions?

RenderOptions = {}

The rendering options the plugin passes to loadConfig.

Returns

ConfigInfo

The config section of the plugin's info.