@types/are-we-there-yet

Version 1.1.2
Published 5 months ago
6.94 kB
1 dependency
MIT license

Install

npm i @types/are-we-there-yet

yarn add @types/are-we-there-yet

pnpm add @types/are-we-there-yet

Overview

TypeScript definitions for are-we-there-yet

Classes

class Tracker

class Tracker extends TrackerBase {}

constructor

constructor(name?: string, todo?: number);

method addWork

addWork: (work: number) => void;

method completed

completed: () => number;

method completeWork

completeWork: (completed: number) => void;

method finish

finish: () => void;

class TrackerBase

class TrackerBase extends EventEmitter {}

constructor

constructor(name?: string);

method addListener

addListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: string, listener: GenericEventListener): this;
};

method on

on: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: string, listener: GenericEventListener): this;
};

method once

once: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: string, listener: GenericEventListener): this;
};

method prependListener

prependListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: string, listener: GenericEventListener): this;
};

method prependOnceListener

prependOnceListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: string, listener: GenericEventListener): this;
};

method removeListener

removeListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: string, listener: GenericEventListener): this;
};

class TrackerGroup

class TrackerGroup extends TrackerBase {}

constructor

constructor(name?: string);

method addUnit

addUnit: (tracker: TrackerBase, weight?: number) => TrackerObject;

method completed

completed: () => number;

method debug

debug: () => string;

method finish

finish: () => void;

method newGroup

newGroup: (name?: string, weight?: number) => TrackerGroup;

method newItem

newItem: (name?: string, todo?: number, weight?: number) => Tracker;

method newStream

newStream: (name?: string, todo?: number, weight?: number) => TrackerStream;

class TrackerStream

class TrackerStream extends Transform {}

constructor

constructor(name?: string, size?: number, options?: TransformOptions);

method addListener

addListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: 'data', listener: (chunk: any) => void): this;
    (event: 'readable' | 'end' | 'close', listener: () => void): this;
    (event: 'error', listener: (err: Error) => void): this;
    (event: string, listener: GenericEventListener): this;
};

method addWork

addWork: (work: number) => void;

method completed

completed: () => number;

method on

on: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: 'data', listener: (chunk: any) => void): this;
    (event: 'readable' | 'end' | 'close', listener: () => void): this;
    (event: 'error', listener: (err: Error) => void): this;
    (event: string, listener: GenericEventListener): this;
};

method once

once: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: 'data', listener: (chunk: any) => void): this;
    (event: 'readable' | 'end' | 'close', listener: () => void): this;
    (event: 'error', listener: (err: Error) => void): this;
    (event: string, listener: GenericEventListener): this;
};

method prependListener

prependListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: 'data', listener: (chunk: any) => void): this;
    (event: 'readable' | 'end' | 'close', listener: () => void): this;
    (event: 'error', listener: (err: Error) => void): this;
    (event: string, listener: GenericEventListener): this;
};

method prependOnceListener

prependOnceListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: 'data', listener: (chunk: any) => void): this;
    (event: 'readable' | 'end' | 'close', listener: () => void): this;
    (event: 'error', listener: (err: Error) => void): this;
    (event: string, listener: GenericEventListener): this;
};

method removeListener

removeListener: {
    (event: 'change', listener: TrackerEventListener): this;
    (event: 'data', listener: (chunk: any) => void): this;
    (event: 'readable' | 'end' | 'close', listener: () => void): this;
    (event: 'error', listener: (err: Error) => void): this;
    (event: string, listener: GenericEventListener): this;
};

Type Aliases

type GenericEventListener

type GenericEventListener = (...args: any[]) => void;

type TrackerEventListener

type TrackerEventListener = (
    name: string,
    completed: number,
    tracker: TrackerObject
) => void;

type TrackerObject

type TrackerObject = Tracker | TrackerGroup | TrackerStream;

Package Files (1)

index.d.ts

Dependencies (1)

@types/node

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto 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/are-we-there-yet.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/are-we-there-yet)

HTML

<a href="https://www.jsdocs.io/package/@types/are-we-there-yet"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 5 months ago.
Package analyzed in 2647 ms.
Missing or incorrect documentation? Open an issue for this package.

@types/are-we-there-yet

Install

Overview

Index

Classes

Type Aliases

Classes

class Tracker

constructor

method addWork

method completed

method completeWork

method finish

class TrackerBase

constructor

method addListener

method on

method once

method prependListener

method prependOnceListener

method removeListener

class TrackerGroup

constructor

method addUnit

method completed

method debug

method finish

method newGroup

method newItem

method newStream

class TrackerStream

constructor

method addListener

method addWork

method completed

method on

method once

method prependListener

method prependOnceListener

method removeListener

Type Aliases

type GenericEventListener

type TrackerEventListener

type TrackerObject

Package Files (1)

Dependencies (1)

Dev Dependencies (0)

Peer Dependencies (0)

Badge