Installation
npm install --save @types/eyes
Summary
This package contains type definitions for eyes (https://github.com/cloudhead/eyes.js).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/eyes.
index.d.ts
/// <reference types="node"/>
import stream = require("stream");
export declare function inspector(options?: EyesOptions): InspectorFunction;
export declare function inspect(thing: any, label?: string): void;
export interface InspectorFunction {
(thing: any, label?: string): string;
}
export interface EyesOptions {
/** Styles applied to stdout */
styles?: {
/** Overall base style applied to everything */
all?: string | undefined;
/** Style when printing inspection labels, like 'array' in `array: [1, 2, 3]` */
label?: string | undefined;
/** Style when printing objects which don't have a literal representation, such as functions */
other?: string | undefined;
/** Style when printing the keys in object literals, like 'a' in `{a: 1}` */
key?: string | undefined;
/** Style when printing `null`, `undefined`, etc. */
special?: string | undefined;
/** Style when printing strings */
string?: string | undefined;
/** Style when printing numbers */
number?: string | undefined;
/** Style when printing booleans */
bool?: string | undefined;
/** Style when printing RegExps */
regexp?: string | undefined;
} | undefined;
/** Indent object literals */
pretty?: boolean | undefined;
/** Don't output functions at all */
hideFunctions?: boolean | undefined;
/** Stream to write to, or null */
stream?: NodeJS.WritableStream | undefined;
/** Truncate output if longer */
maxLength?: number | undefined;
}
Additional Details
- Last updated: Tue, 07 Nov 2023 03:09:37 GMT
- Dependencies: @types/node
Credits
These definitions were written by bryn austin bellomy.