Logo for jsDocs.io

@wdio/config

  • Version 9.21.0
  • Published
  • 39.4 kB
  • 6 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

Variables

Functions

Interfaces

Variables

variable DEFAULT_MAX_INSTANCES_PER_CAPABILITY_VALUE

const DEFAULT_MAX_INSTANCES_PER_CAPABILITY_VALUE: number;

    Functions

    function DEFAULT_CONFIGS

    DEFAULT_CONFIGS: () => WebdriverIO.Config;

      function defineConfig

      defineConfig: (
          options?: Partial<WebdriverIO.Config> | WebdriverIO.Config
      ) => WebdriverIO.Config;

      • Creates a configuration object while providing types for both TypeScript and Javascript

      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 (6)

                      Dev Dependencies (1)

                      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>