rsformat/lib/index.d.ts

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

import { RsString, style } from './format';
export { print, println, eprint, eprintln, dbg } from './print';
type ParameterReference = {
    __rs_param_ref: number;
};
type rs = {
    (strings: TemplateStringsArray, ...params: any[]): RsString;
    /**
     * Tag to use Rust-style formatting in a template literal.
     * Returns a `string` primitive.
     *
     * ```js
     * let number = 14;
     * let info = rs.raw`${number+1} is ${rs.ref(0)}:x in hex`;
     * // info === '15 is f in hex'
     * ```
     *
     * @returns a string primitive of the formatted string
     */
    raw: (strings: TemplateStringsArray, ...params: any[]) => string;
    /**
     * Reference another parameter in a `rs`-tagged template.
     *
     * @param n Number of parameter to reference
     * @returns A reference to the `n`th parameter
     */
    ref: (n: number) => ParameterReference;
    /**
     * Format a string using one or more of [the modifiers provided by node's `util` module](https://nodejs.org/docs/latest-v22.x/api/util.html#modifiers).
     * This is a re-export of `util.styleText`.
     */
    style: typeof style;
};
/**
* Tag to use Rust-style formatting in a template literal.
* Returns an extended `String` object.
*
* ```js
* let number = 14;
* let info = rs`${number+1} is ${rs.ref(0)}:x in hex`;
* // info == '15 is f in hex'
* ```
*
* @returns a String object with the formatted string
*/
export declare let rs: rs;