Logo for jsDocs.io

@wdio/config

  • Version 8.39.0
  • Published
  • 48.5 kB
  • 7 dependencies
  • MIT license

Install

npm i @wdio/config
yarn add @wdio/config
pnpm add @wdio/config

Overview

A helper utility to parse and validate WebdriverIO options

Index

Functions

Interfaces

Functions

function DEFAULT_CONFIGS

DEFAULT_CONFIGS: () => Omit<Options.Testrunner, 'capabilities'>;

    function isCloudCapability

    isCloudCapability: (caps: WebdriverIO.Capabilities) => boolean;

      function validateConfig

      validateConfig: <T>(
          defaults: Options.Definition<T>,
          options: T,
          keysToKeep?: (keyof T)[]
      ) => T;

      • validates configurations based on default values

        Parameter defaults

        object describing all allowed properties

        Parameter options

        option to check against {Object} validated config enriched with default values

      Interfaces

      interface ModuleImportService

      interface ModuleImportService {}

        method import

        import: <T>(module: string) => Promise<T>;

          interface PathService

          interface PathService {}

            method ensureAbsolutePath

            ensureAbsolutePath: (path: string, rootDir: string) => string;

              method glob

              glob: (pattern: string, rootDir: string) => string[];

                method isFile

                isFile: (path: string) => boolean;

                  method loadFile

                  loadFile: <T>(path: string) => Promise<T>;

                    Package Files (4)

                    Dependencies (7)

                    Dev Dependencies (2)

                    Peer Dependencies (0)

                    No peer dependencies.

                    Badge

                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@wdio/config.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@wdio/config)
                    • HTML
                      <a href="https://www.jsdocs.io/package/@wdio/config"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>