Options
All
  • Public
  • Public/Protected
  • All
Menu

Module configuration

The configuration settings.

It may be merged from the following sources of settings, in order:

Default settings Global settings Organization settings (for all organizations the user is a member of) User settings Repository settings Directory settings

todo

Add a way to get/update configuration for a specific scope or subject.

todo

Support applying defaults to the configuration values.

Index

Functions

Functions

get

  • Returns the full configuration object.

    template

    C The configuration schema.

    Type parameters

    • C: object

    Returns Configuration<C>

    The full configuration object.

subscribe

  • Subscribe to changes to the configuration. The next callback is called when any configuration value changes (and synchronously immediately). Call get in the callback to obtain the new configuration values.

    template

    C The configuration schema.

    Parameters

    • next: function
        • (): void
        • Returns void

    Returns Unsubscribable

    An unsubscribable to stop calling the callback for configuration changes.

Generated using TypeDoc