rsformat/lib/print.d.ts

Formatting/printing library for JavaScript that takes after rust's string formatting

import type { Writable } from 'node:stream';
/**
 * Print a string (or instance of String/RsString) to a `Writable` stream.
 *
 * @param stream Stream to print the string to
 * @param string String to print
 * @param newline Whether to append a newline after the string
 * @param colored Whether to use colors for `rs` debug formatting
 */
export declare function printToStream(stream: Writable, string: string | String, newline?: boolean, colored?: boolean): void;
/**
 * Print a string to stdout.
 *
 * @param string String to print
 */
export declare function print(string: string | String): void;
/**
 * Print a string to stdout and append a newline.
 *
 * @param string String to print
 */
export declare function println(string: string | String): void;
/**
 * Print a string to stderr.
 *
 * @param string String to print
 */
export declare function eprint(string: string | String): void;
/**
 * Print a string to stderr and append a newline.
 *
 * @param string String to print
 */
export declare function eprintln(string: string | String): void;
/**
 * Debug print a value to stderr and return it.
 *
 * ```js
 * let r = Math.random();
 * if(dbg(r < 0.3)) { // prints 'true' or 'false'
 *     println("Unlucky!");
 * }
 * ```
 *
 * @param value Value to debug print
 */
export declare function dbg(value: any): any;