Logo for jsDocs.io

@types/prettyjson

  • Version 0.0.33
  • Published
  • 5.31 kB
  • No dependencies
  • MIT license

Install

npm i @types/prettyjson
yarn add @types/prettyjson
pnpm add @types/prettyjson

Overview

TypeScript definitions for prettyjson

Index

Variables

Functions

Interfaces

Variables

variable version

var version: string;

  • Defines prettyjson version

Functions

function render

render: (data: any, options?: RendererOptions, indentation?: number) => string;

  • Render pretty json.

    Parameter data

    Data to prettify.

    Parameter options

    Hash with different options to configure the renderer.

    Parameter indentation

    Indentation size.

    {string} pretty serialized json data ready to display.

function renderString

renderString: (
    data: string,
    options?: RendererOptions,
    indentation?: number
) => string;

  • Render pretty json from a string.

    Parameter data

    Serialized JSON data to prettify.

    Parameter options

    Hash with different options to configure the renderer.

    Parameter indentation

    Indentation size.

    {string} pretty serialized json data ready to display.

Interfaces

interface RendererOptions

interface RendererOptions {}

    property dashColor

    dashColor?: string | undefined;

      property defaultIndentation

      defaultIndentation?: number | undefined;

        property emptyArrayMsg

        emptyArrayMsg?: string | undefined;

        • Define behavior for Array objects

        property inlineArrays

        inlineArrays?: boolean | undefined;

          property keysColor

          keysColor?: string | undefined;

            property noAlign

            noAlign?: boolean | undefined;

              property noColor

              noColor?: boolean | undefined;

              • Color definition

              property numberColor

              numberColor?: string | undefined;

                property stringColor

                stringColor?: string | undefined;

                  Package Files (1)

                  Dependencies (0)

                  No dependencies.

                  Dev Dependencies (0)

                  No dev dependencies.

                  Peer Dependencies (0)

                  No peer dependencies.

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/prettyjson.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/prettyjson)
                  • HTML
                    <a href="https://www.jsdocs.io/package/@types/prettyjson"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>