# @base2/pretty-print-object

> Convert an object or array into a formatted string

Latest version **1.0.2** (published 2022-04-28) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install @base2/pretty-print-object
pnpm add @base2/pretty-print-object
yarn add @base2/pretty-print-object
bun add @base2/pretty-print-object
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-04-28 |
| First published | 2019-09-02 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Chris Baker |
| Maintainers | chris-baker |
| Keywords | object, stringify, pretty, print, dump, format, type, json |

## Links

- npm: https://www.npmjs.com/package/@base2/pretty-print-object
- Repository: https://github.com/Chris-Baker/pretty-print-object
- Homepage: https://github.com/Chris-Baker/pretty-print-object#readme
- Issues: https://github.com/Chris-Baker/pretty-print-object/issues
- npm.io page: https://npm.io/package/@base2/pretty-print-object

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-04-28
- 1.0.1 — 2021-03-31
- 1.0.0 — 2019-09-02
- 0.0.6 — 2019-09-02
- 0.0.5 — 2019-09-02
- 0.0.4 — 2019-09-02
- 0.0.3 — 2019-09-02
- 0.0.2 — 2019-09-02
- 0.0.1 — 2019-09-02

## README

# Pretty print object
[![License][license-image]][license-url] ![coverage-badge-green]
 
> Convert an object or array into a formatted string

This is a re-write of [stringify-object] in Typescript, modified to inline the dependencies and make it compatible with ES5 out of the box.

Useful for when you want to get the string representation of an object in a formatted way.

It also handles circular references and lets you specify quote type.


## Install

```
$ npm install @base2/pretty-print-object
```


## Usage

```js
import { prettyPrint } from '@base2/pretty-print-object';

const obj = {
    foo: 'bar',
    'arr': [1, 2, 3],
    nested: {
        hello: "world"
    }
};

const pretty = prettyPrint(obj, {
    indent: '  ',
    singleQuotes: false
});

console.log(pretty);
/*
{
    foo: "bar",
    arr: [
        1,
        2,
        3
    ],
    nested: {
        hello: "world"
    }
}
*/
```


## API

### prettyPrint(input, [options])

Circular references will be replaced with `"[Circular]"`.

Object keys are only quoted when necessary, for example, `{'foo-bar': true}`.

#### input

Type: `Object` `Array`

#### options

Type: `Object`

##### indent

Type: `string`<br>
Default: `\t`

Preferred indentation.

##### singleQuotes

Type: `boolean`<br>
Default: `true`

Set to false to get double-quoted strings.

##### filter(obj, prop)

Type: `Function`

Expected to return a `boolean` of whether to include the property `prop` of the object `obj` in the output.

##### transform(obj, prop, originalResult)

Type: `Function`<br>
Default: `undefined`

Expected to return a `string` that transforms the string that resulted from stringifying `obj[prop]`. 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`.

Here's an example that uses the `transform` option to mask fields named "password":

```js
import { prettyPrint } from '@base2/pretty-print-object';

const obj = {
    user: 'becky',
    password: 'secret'
};

const pretty = prettyPrint(obj, {
    transform: (obj, prop, originalResult) => {
        if (prop === 'password') {
            return originalResult.replace(/\w/g, '*');
        }

        return originalResult;
    }
});

console.log(pretty);
/*
{
    user: 'becky',
    password: '******'
}
*/
```


##### inlineCharacterLimit

Type: `number`

When set, will inline values up to `inlineCharacterLimit` length for the sake of more terse output.

For example, given the example at the top of the README:

```js
import { prettyPrint } from '@base2/pretty-print-object';

const obj = {
    foo: 'bar',
    'arr': [1, 2, 3],
    nested: {
        hello: "world"
    }
};

const pretty = prettyPrint(obj, {
    indent: '  ',
    singleQuotes: false,
    inlineCharacterLimit: 12
});

console.log(pretty);
/*
{
    foo: "bar",
    arr: [1, 2, 3],
    nested: {
        hello: "world"
    }
}
*/
```

As you can see, `arr` was printed as a one-liner because its string was shorter than 12 characters.

[stringify-object]: https://www.npmjs.com/package/stringify-object
[coverage-badge-green]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg
[license-url]: https://opensource.org/licenses/BSD-2-Clause
[license-image]: https://img.shields.io/badge/License-BSD%202--Clause-orange.svg

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