# @types/stringify-object

> TypeScript definitions for stringify-object

Latest version **4.0.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/stringify-object
pnpm add @types/stringify-object
yarn add @types/stringify-object
bun add @types/stringify-object
```

## Health

**Score 50/100 (C)** — status: abandoned.

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

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.5 |
| Published | 2023-11-07 |
| First published | 2017-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Recent versions

- 4.0.5 (latest) — 2023-11-07
- 4.0.2 (ts4.2) — 2022-12-10
- 4.0.1 (ts3.8) — 2021-12-24
- 4.0.0 (ts3.7) — 2021-09-24
- 3.3.1 (ts3.6) — 2021-07-02
- 3.3.0 (ts3.0) — 2020-05-14
- 3.2.0 (ts2.2) — 2018-02-13
- 3.1.1 (ts2.0) — 2017-03-31
- 4.0.4 — 2023-10-18
- 4.0.3 — 2023-10-10
- 3.1.0 — 2017-03-08

## README

# Installation
> `npm install --save @types/stringify-object`

# Summary
This package contains type definitions for stringify-object (https://github.com/yeoman/stringify-object).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stringify-object.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stringify-object/index.d.ts)
````ts
/**
 * Stringify an object/array like JSON.stringify just without all the double-quotes
 */
export default function stringifyObject(input: any, options?: Options, pad?: string): string;

export interface Options {
    /**
     * Preferred indentation
     * @default '\t'
     */
    indent?: string | undefined;
    /**
     * Set to false to get double-quoted strings
     * @default true
     */
    singleQuotes?: boolean | undefined;
    /**
     * Expected to return a boolean of whether to include the property property of the object object in the output.
     */
    filter?(input: any, prop: string | symbol): boolean;
    /**
     * When set, will inline values up to inlineCharacterLimit length for the sake of more terse output.
     */
    inlineCharacterLimit?: number | undefined;
    /**
     * Expected to return a string that transforms the string that resulted from stringifying object[property].
     * This can be used to detect special types of objects that need to be stringified in a particular way.
     * The transform function might return an alternate string in this case, otherwise returning the originalResult.
     */
    transform?: ((input: any[] | object, prop: number | string | symbol, originalResult: string) => string) | undefined;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).

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