@nuxtjs/module-test-utils

  • Version 1.6.3
  • Published
  • 11.9 kB
  • 5 dependencies
  • MIT license

Install

npm i @nuxtjs/module-test-utils
yarn add @nuxtjs/module-test-utils
pnpm add @nuxtjs/module-test-utils

Overview

Test utilities for modules Nuxt.js

Index

Variables

variable get

const get: GetRequest<any>;

    Functions

    function build

    build: (
    config: Configuration,
    options?: { waitFor?: number; beforeNuxtReady?: BeforeNuxtReadyFn }
    ) => Promise<{ nuxt: any; builder: any }>;

      function generate

      generate: (
      config: Configuration,
      options?: { build?: boolean; init?: boolean },
      initOptions?: { beforeNuxtReady?: BeforeNuxtReadyFn }
      ) => Promise<{ nuxt: any; builder: any; generator: any }>;

        function generatePort

        generatePort: (port?: number) => Promise<number>;

          function init

          init: (
          config: Configuration,
          options?: { beforeNuxtReady?: BeforeNuxtReadyFn }
          ) => Promise<any>;

            function loadConfig

            loadConfig: (
            dir: string,
            fixture?: string,
            override?: Configuration,
            options?: { merge?: boolean }
            ) => Configuration;

              function setup

              setup: (
              config: Configuration,
              options?: {
              port?: number;
              waitFor?: number;
              beforeNuxtReady?: BeforeNuxtReadyFn;
              }
              ) => Promise<{ nuxt: any; builder: any }>;

                function url

                url: (path?: string) => string;

                  Type Aliases

                  type BeforeNuxtReadyFn

                  type BeforeNuxtReadyFn = (nuxt: any /*TBD*/) => Promise<void>;

                    type GetRequest

                    type GetRequest<T = any> = (
                    path: string,
                    options?: RequestPromiseOptions
                    ) => Promise<T>;

                      Package Files (1)

                      Dependencies (5)

                      Dev Dependencies (10)

                      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/@nuxtjs/module-test-utils.

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