Logo for jsDocs.io

telejson

  • Version 7.2.0
  • Published
  • 119 kB
  • 1 dependency
  • MIT license

Install

npm i telejson
yarn add telejson
pnpm add telejson

Overview

A library for teleporting rich data to another place.

Index

Functions

Interfaces

Functions

function isJSON

isJSON: (input: string) => RegExpMatchArray | null;

    function parse

    parse: (data: string, options?: Partial<Options>) => any;

      function replacer

      replacer: (options: Options) => any;

        function reviver

        reviver: (options: Options) => any;

          function stringify

          stringify: (data: unknown, options?: Partial<Options>) => string;

            Interfaces

            interface Options

            interface Options {}

              property allowClass

              allowClass: boolean;

                property allowDate

                allowDate: boolean;

                  property allowError

                  allowError: boolean;

                    property allowFunction

                    allowFunction: boolean;

                      property allowRegExp

                      allowRegExp: boolean;

                        property allowSymbol

                        allowSymbol: boolean;

                          property allowUndefined

                          allowUndefined: boolean;

                            property lazyEval

                            lazyEval: boolean;

                              property maxDepth

                              maxDepth: number;

                                property space

                                space: number | undefined;

                                  Package Files (1)

                                  Dependencies (1)

                                  Dev Dependencies (22)

                                  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/telejson.

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