@pumpkin-plugins/config API / schema / TableNode

Interface: TableNode<F>

Defined in: tools/config/src/schema.ts:16

A table of named entries that share the same optional settings, such as per-file overrides. Entries are written as [name."entry"] tables and are user data: they are kept as they are.

Type Parameters

F

F extends Fields = Fields

Properties

defaults?

readonly optional defaults?: TableValues<F>

Defined in: tools/config/src/schema.ts:25

Entries written into a fresh configuration file. Users may remove them afterwards.

---

description

readonly description: string

Defined in: tools/config/src/schema.ts:19

What the entries are for.

---

entryName

readonly entryName: string

Defined in: tools/config/src/schema.ts:21

What an entry is named after in the documentation, such as file for overrides."<file>".

---

exampleKey

readonly exampleKey: string

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

An entry name used in the commented example.

---

fields

readonly fields: F

Defined in: tools/config/src/schema.ts:27

The settings every entry may have. They are all optional.