StringTune/Docs

API Reference

StringSettings

Settings type used for global fallback values and per-module overrides.

StringSettings

StringSettings is the settings map type used throughout the runtime.

Public status

This type lives in src/utils. It is useful reference for authoring, but the behavioral contract is covered mainly by Settings Reference.

Shape

TypeScript
interface StringSettings {
  [key: string]: string | number | boolean;
}

What it is for

It represents:

  • global fallback settings passed into setupSettings(...)
  • per-module override settings passed into use(MyModule, settings)

Practical note

The type is intentionally broad because many StringTune settings are attribute-like values that stay string-based until a module parses them.