@types/run-sequence

  • Version 2.2.0
  • Published
  • 7.52 kB
  • 3 dependencies
  • MIT license

Install

npm i @types/run-sequence
yarn add @types/run-sequence
pnpm add @types/run-sequence

Overview

TypeScript definitions for run-sequence

Index

Variables

Interfaces

Type Aliases

Variables

variable r

const r: r.RunSequence;

    Interfaces

    interface RunSequence

    interface RunSequence {}

      property options

      options: {
      /**
      * When set to `false`, this suppresses the full stack trace from errors captured
      * during a sequence.
      *
      * @default true
      */
      showErrorStackTrace: boolean;
      /**
      * When set to `true`, this enables you to pass falsey values
      * in which will be stripped from the task set before validation and sequencing.
      *
      * @default false
      */
      ignoreUndefinedTasks: boolean;
      };
      • There are a few global options you can configure on the runSequence function.

        Please note these are **global to the module**, and once set will affect every use of runSequence.

      method use

      use: (gulp: gulp.Gulp) => RunSequence;
      • If you have a complex gulp setup with your tasks split up across different files, you may get the error that run-sequence is unable to find your tasks. In this case, you can configure run-sequence to look at the gulp within the submodule.

      call signature

      (...tasks: [...r.Task[], undertaker.TaskCallback]): NodeJS.ReadWriteStream;
      • Runs a sequence of gulp tasks in the specified order. This function is designed to solve the situation where you have defined run-order, but choose not to or cannot use dependencies.

        Each argument to run-sequence is run in order. This works by listening to the task_stop and task_err events, and keeping track of which tasks have been completed. You can still run some of the tasks in parallel, by providing an array of task names for one or more of the arguments.

        If the final argument is a function, it will be used as a callback after all the functions are either finished or an error has occurred.

      call signature

      (...tasks: r.Task[]): NodeJS.ReadWriteStream;

        Type Aliases

        type Task

        type Task = string | string[] | null | undefined;

          Package Files (1)

          Dependencies (3)

          Dev Dependencies (0)

          No dev dependencies.

          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/@types/run-sequence.

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