# @types/quick-format-unescaped

> TypeScript definitions for quick-format-unescaped

Latest version **4.0.3** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/quick-format-unescaped
pnpm add @types/quick-format-unescaped
yarn add @types/quick-format-unescaped
bun add @types/quick-format-unescaped
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2023-11-21 |
| First published | 2020-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/quick-format-unescaped
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/quick-format-unescaped
- npm.io page: https://npm.io/package/@types/quick-format-unescaped

## Recent versions

- 4.0.3 (latest) — 2023-11-21
- 4.0.0 (ts3.2) — 2020-09-28
- 4.0.2 — 2023-11-07
- 4.0.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/quick-format-unescaped`

# Summary
This package contains type definitions for quick-format-unescaped (https://github.com/davidmarkclements/quick-format-unescaped#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/quick-format-unescaped.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/quick-format-unescaped/index.d.ts)
````ts
/**
 * Alternative to NodeJS `util.format`. Does not escape strings.
 * @description Uses `JSON.stringify` instead of `util.inspect`, this means functions _will not be serialized_.
 * @param fmt A printf-like format string. Example: `'hello %s %j %d'`
 * @param parameters Values to be inserted into the `fmt` string. Example: `['world', {obj:true}]`
 * @param options Passing an options object as the third parameter with a `stringify` will mean any objects will be passed
 * to the supplied function instead of an the internal `tryStringify` function. This can be useful when using augmented
 * capability serializers such as `fast-safe-stringify` or `fast-redact`.
 * @example
 * format('hello %s %o', ['world', {obj: true}])
 * // 'hello world {"obj": true}'
 */
declare function format(fmt: string, parameters: readonly unknown[], options?: format.Options): string;

declare namespace format {
    interface Options {
        /**
         * Function that stringifies objects.
         */
        stringify: (o: unknown) => string;
    }
}

export = format;

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: none

# Credits
These definitions were written by [Adam Vigneaux](https://github.com/AdamVig).

---
_Source: https://npm.io/package/@types/quick-format-unescaped · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._