Package Exports

json-truncator
json-truncator/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (json-truncator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JsonTruncator

JsonTruncator is a utility class designed for truncating JSON objects or arrays to a specified maximum length. This tool is particularly useful for managing large JSON data by limiting the amount of data displayed, which can help in debugging and logging scenarios. JsonTruncator supports both objects and arrays, including nested structures, ensuring that even deeply nested JSON data can be truncated efficiently.

Installation
Usage
Options
Author

Installation

To use JsonTruncator, install the package via npm. You can install it locally within your project or globally if you intend to use it as a CLI tool.

1. Install dependencies:

NPM

npm i json-truncator

PNPM

pnpm i json-truncator

2.Install the package globally (optional, for CLI usage):

NPM

npm install -g json-truncator

PNPM

npm install -g json-truncator

Installing the package globally allows you to use the truncate-json command directly from the command line.

Usage

Importing the Class

To utilize the JsonTruncator class in your project, import it as follows:

import { JsonTruncator } from "json-truncator";

Using the `truncate` Method

The truncate method allows you to truncate JSON objects or arrays to a maximum number of items. Here is how you can use it:

Example

import { JsonTruncator } from "json-truncator";

const inputArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
const truncatedArray = JsonTruncator.truncate(inputArray, 5);

console.log(truncatedArray);
// Output: [1, 2, 3, 4, 5, '...']

const inputObject = { a: 1, b: 2, c: 3, d: 4, e: 5 };
const truncatedObject = JsonTruncator.truncate(inputObject, 3);

console.log(truncatedObject);
// Output: { a: 1, b: 2, c: 3, etc: '...' }

CLI Usage

If the package is installed globally, you can use it directly from the command line to truncate JSON data.

Commands

Truncate a JSON Array or Object using a predefined command::

  truncate-json -c deepArrayObject -l 5

Truncate a JSON Array by providing custom data: (Note: Custom data support will be available in the next update)

  truncate-json -c customArray -d '[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]' -l 5

Truncate a JSON Object by providing custom data: (Note: Custom data support will be available in the next update)

  truncate-json -c customObject -d '{"a": 1, "b": 2, "c": 3, "d": 4, "e": 5}' -l 3

Note Currently, the CLI supports truncation using predefined commands only. The ability to provide custom data for truncation will be introduced in the next update.

Options

-c, --command <command>: Command to execute (Available commands: deepArrayObject, arrayObject, notArrayObject, mixedArray, deepObject, object, mixedObject).
-l, --length <number>: Maximum number of items to be displayed, default 3.
-d, --data <json>: JSON data to be truncated (used with customArray or customObject).

Author

Garsetayusuf

Email: garsetayusuf@gmail.com

json-truncator