iya-sts
    Preparing search index...

    Draws the Settings block a console page carries, from the settings member of that page's management API answer.

    A static utility class; it holds no state and takes no dependencies.

    Index
    • Says, in a sentence for a page's notes, whether a change made on it is kept across a restart, and how to keep it when it is not.

      Parameters

      • context: any

        the settings block's context: the appconfig file, the two persistence facts, the mode and the ambient realm

      • Optionalt: any

        the page's translator (#539); optional

      Returns string

      the sentence as HTML

    • Draws the Settings block a console page carries: the lead notes on persistence, restart-only rows and overrides, then one section form per group the page owns.

      Parameters

      • settings: any

        the page's settings block, as the management API answers it (groups, context, sharedWith)

      • path: any

        the page's path

      • Optionalonly: any

        optional; the names of the groups to draw, for a page that puts each of its groups on a tab of its own (/admin/listeners, #423)

      • Optionalt: any

        the page's translator (#539); optional, the default when omitted — a page passes its ctx.t

      Returns string

      the block as HTML, or an empty string when the page owns no settings group (or none of only)

    • Says whether an override written from a page with this context is kept across a restart.

      Parameters

      • context: any

        the settings block's context

      • Optionalkey: any

        the setting, when the question is about one; optional

      Returns boolean

      true when the store under the write persists it

    • Draws an ordered choice from a closed list as a table of checkboxes and order numbers.

      Parameters

      • setting: any

        the described setting (ordered, csvValues)

      • id: any

        the id the row's label points at, given to the first box

      • Optionalt: any

        the page's translator (#539); optional

      Returns string

      the control as HTML

    • Words where a runtime override set on these pages is held.

      Parameters

      • context: any

        the settings block's context

      • Optionalkey: any

        the setting, when it is about one; optional

      • Optionalt: any

        the page's translator (#539); optional

      Returns any

      kept in the store or in memory only, as plain text

    • Draws one setting as a table row: its key with the description as a tooltip, its control, its source and, when overridden, a Reset button.

      A restart-only setting is drawn with its control disabled and the reason beside it.

      Parameters

      • setting: any

        the described setting

      • from: any

        the page the row is drawn on; not read by the row itself

      • context: any

        the settings block's context

      • Optionalt: any

        the page's translator (#539); optional

      Returns string

      the table row as HTML

    • Draws one settings group as a form that posts every row at once (set-many) to /admin/config, with a Save button when any row is editable.

      Parameters

      • group: any

        the described settings group

      • from: any

        optional; the page to return to after a save

      • context: any

        the settings block's context

      • Optionalt: any

        the page's translator (#539); optional

      Returns string

      the heading and form as HTML

    • The values an ordered choice's Select all ticks (#1130): every value, less those an onlyWhileOn rule governs while its switch is off, and only those an aloneWhileOn rule names while its switch is on.

      Parameters

      • setting: any

        the described setting (csvValues, selectAll)

      • OptionalisOn: (rule: any) => boolean

        optional; answers whether a switch is on, given the rule ({ setting, on, canBeOn }); the rule's own on when omitted

      Returns string[]

      the values, in the list's own order

    • Words the note that a settings group is also drawn on other pages, linking to each.

      Parameters

      • others: any

        the other pages, each { path, label }

      • Optionalt: any

        the page's translator (#539); optional

      Returns string

      the sentence as HTML, or an empty string when no other page draws the group

    • Words where a setting's value came from: a runtime override, an environment variable, the legacy variable, the appconfig file, the default appconfig file, or another setting.

      Parameters

      • setting: any

        the described setting

      • context: any

        the settings block's context: the two file names

      • Optionalt: any

        the page's translator (#539); optional, the default when omitted

      Returns any

      the phrase as plain text