@types/nodemon

Version 1.19.6
Published 1 year ago
8.76 kB
1 dependency
MIT license

Install

npm i @types/nodemon

yarn add @types/nodemon

pnpm add @types/nodemon

Overview

TypeScript definitions for nodemon

Functions

function addListener

addListener: {
    (event: string | symbol, listener: (...args: any[]) => void): typeof nodemon;
    (
        event: 'start' | 'exit' | 'crash' | 'config:update' | 'readable',
        listener: () => void
    ): typeof nodemon;
    (event: 'restart', listener: (files?: string[]) => void): typeof nodemon;
    (event: 'quit', listener: (code?: number) => void): typeof nodemon;
    (event: 'watching', listener: (file: string) => void): typeof nodemon;
    (event: 'log', listener: (msg: LogMessage) => void): typeof nodemon;
    (event: 'stdout' | 'stderr', listener: (data: Buffer) => void): typeof nodemon;
};

function emit

emit: {
    (event: string | symbol, ...args: any[]): boolean;
    (event: 'start' | 'exit' | 'crash' | 'config:update' | 'readable'): boolean;
    (event: 'quit', code?: number): boolean;
    (event: 'restart', files?: string[]): boolean;
    (event: 'watching', listener: (file: string) => void): boolean;
    (event: 'log', msg: LogMessage): boolean;
    (event: 'stdout' | 'stderr', data: Buffer): boolean;
};

function nodemon

nodemon: typeof nodemon;

function on

on: {
    (event: string | symbol, listener: (...args: any[]) => void): typeof nodemon;
    (
        event: 'start' | 'exit' | 'crash' | 'config:update' | 'readable',
        listener: () => void
    ): typeof nodemon;
    (event: 'restart', listener: (files?: string[]) => void): typeof nodemon;
    (event: 'quit', listener: (code?: number) => void): typeof nodemon;
    (event: 'watching', listener: (file: string) => void): typeof nodemon;
    (event: 'log', listener: (msg: LogMessage) => void): typeof nodemon;
    (event: 'stdout' | 'stderr', listener: (data: Buffer) => void): typeof nodemon;
};

function once

once: {
    (event: string | symbol, listener: (...args: any[]) => void): typeof nodemon;
    (
        event: 'start' | 'exit' | 'crash' | 'config:update' | 'readable',
        listener: () => void
    ): typeof nodemon;
    (event: 'quit', listener: (code?: number) => void): typeof nodemon;
    (event: 'restart', listener: (files?: string[]) => void): typeof nodemon;
    (event: 'watching', listener: (file: string) => void): typeof nodemon;
    (event: 'log', listener: (msg: LogMessage) => void): typeof nodemon;
    (event: 'stdout' | 'stderr', listener: (data: Buffer) => void): typeof nodemon;
};

function removeAllListeners

removeAllListeners: (event?: string | symbol) => typeof nodemon;

function reset

reset: (done?: () => void) => void;

function restart

restart: () => void;

Interfaces

interface LogMessage

interface LogMessage {}

property colour

colour: string;

property message

message: string;

property type

type: string;

interface Settings

interface Settings {}

property args

args?: readonly string[] | undefined;

property colours

colours?: boolean | undefined;

Set to false to disable color output

property cwd

cwd?: string | undefined;

Change into before running the script

property delay

delay?: number | undefined;

Debounce restart in seconds.

property dump

dump?: boolean | undefined;

Print full debug configuration

property env

env?: { [key: string]: string | boolean | number } | undefined;

property events

events?: { [key: string]: string } | undefined;

property exec

exec?: string | undefined;

Execute script with "app", ie. -x "python -v". May use variables.

property execMap

execMap?:
    | {
          [k: string]: any;
      }
    | undefined;

The global config file is useful for setting up default executables

property exitcrash

exitcrash?: boolean | undefined;

Exit on crash, allows use of nodemon with daemon tools like forever.js.

property ext

ext?: string | undefined;

Extensions to look for, ie. js,jade,hbs.

property ignore

ignore?: ReadonlyArray<string | { re: string }> | undefined;

Ignore specific files or directories. One entry per ignored value. Wildcards are allowed.

property ignoreRoot

ignoreRoot?: string[] | undefined;

Root paths to ignore

property legacyWatch

legacyWatch?: boolean | undefined;

Forces node to use the most compatible version for watching file changes.
Use polling to watch for changes (typically needed when watching over a network/Docker)

property nodeArgs

nodeArgs?: readonly string[] | undefined;

Arguments to pass to node if exec is "node"

property noUpdateNotifier

noUpdateNotifier?: boolean | undefined;

Opt-out of update version check

property pollingInterval

pollingInterval?: number | undefined;

Combined with legacyWatch, milliseconds to poll for (default 100)

property quiet

quiet?: boolean | undefined;

Minimise nodemon messages to start/stop only.

property restartable

restartable?: string | undefined;

property runOnChangeOnly

runOnChangeOnly?: boolean | undefined;

Execute script on change only, not startup

property script

script?: string | undefined;

property scriptPosition

scriptPosition?: number | undefined;

property signal

signal?: string | undefined;

Use specified kill signal instead of default (ex. SIGTERM)

property spawn

spawn?: boolean | undefined;

Force nodemon to use spawn (over fork) [node only]

property stdin

stdin?: boolean | undefined;

Try to read from stdin. Set to false to have nodemon pass stdin directly to child process

property stdout

stdout?: boolean | undefined;

property verbose

verbose?: boolean | undefined;

Show detail on what is causing restarts.

property watch

watch?: ReadonlyArray<string | { re: string }> | undefined;

Watch directory or file. One entry per watched value. Wildcards are allowed.

index signature

[k: string]: any;

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/nodemon.

Markdown

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

HTML

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

Updated 1 year ago.
Package analyzed in 2808 ms.
Missing or incorrect documentation? Open an issue for this package.

@types/nodemon

Install

Overview

Index

Functions

Interfaces

Functions

function addListener

function emit

function nodemon

function on

function once

function removeAllListeners

function reset

function restart

Interfaces

interface LogMessage

property colour

property message

property type

interface Settings

property args

property colours

property cwd

property delay

property dump

property env

property events

property exec

property execMap

property exitcrash

property ext

property ignore

property ignoreRoot

property legacyWatch

property nodeArgs

property noUpdateNotifier

property pollingInterval

property quiet

property restartable

property runOnChangeOnly

property script

property scriptPosition

property signal

property spawn

property stdin

property stdout

property verbose

property watch

index signature

Package Files (1)

Dependencies (1)

Dev Dependencies (0)

Peer Dependencies (0)

Badge