Options
All
  • Public
  • Public/Protected
  • All
Menu

Package @tscmono/config

Index

References

Config Functions

References

JSONSchema

Re-exports JSONSchema

loadConfig

Re-exports loadConfig

Config Functions

Const loadConfig

  • loadConfig<T>(schema: JSONSchema, name: string, rootDir?: undefined | string): Promise<T>
  • Uses cosmiconfig to obtain configuration and then match it against a JSON Schema to validate, and finally resolve the configuration

    Type parameters

    • T

    Parameters

    • schema: JSONSchema

      The JSON Schema to match config against

    • name: string

      The name of the config module name

    • Optional rootDir: undefined | string

      The directory used to find the monorepo root

    Returns Promise<T>

Generated using TypeDoc