Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/truncate-json
Truncate a JSON string.
https://github.com/ehmicky/truncate-json
javascript json json-parser length library limit maximum nodejs parse parsing serialization serialize shortener size size-calculation string stringify truncate types typescript
Last synced: 3 months ago
JSON representation
Truncate a JSON string.
- Host: GitHub
- URL: https://github.com/ehmicky/truncate-json
- Owner: ehmicky
- License: mit
- Created: 2022-07-31T19:06:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:52:57.000Z (4 months ago)
- Last Synced: 2024-10-11T10:17:02.535Z (3 months ago)
- Topics: javascript, json, json-parser, length, library, limit, maximum, nodejs, parse, parsing, serialization, serialize, shortener, size, size-calculation, string, stringify, truncate, types, typescript
- Language: JavaScript
- Homepage:
- Size: 6.36 MB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/truncate-json)
[](https://unpkg.com/truncate-json?module)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/truncate-json)
[](https://bundlephobia.com/package/truncate-json)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
Truncate a JSON string.
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Examples
```js
import truncateJson from 'truncate-json'
// Object properties and array items beyond `maxSize` are omitted.
const maxSize = 15
const jsonString = JSON.stringify({ a: 'one', b: 'two' })
console.log(jsonString)
// '{"a":"one","b":"two"}' (21 bytes)
console.log(truncateJson(jsonString, maxSize).jsonString)
// '{"a":"one"}' (11 bytes)
```
```js
// Works deeply inside objects and arrays
const jsonString = JSON.stringify([
'one',
{ a: 'two', b: { c: 'three', d: 'four' } },
'five',
])
console.log(jsonString)
// '["one",{"a":"two","b":{"c":"three","d":"four"}},"five"]' (55 bytes)
const returnValue = truncateJson(jsonString, 40)
console.log(returnValue.jsonString)
// '["one",{"a":"two","b":{"c":"three"}}]' (37 bytes)
// Omitted/truncated properties are returned
console.log(returnValue.truncatedProps)
// [
// { path: [ 1, 'b', 'd' ], value: 'four' },
// { path: [ 2 ], value: 'five' }
// ]
const isTruncated = returnValue.truncatedProps.length !== 0
console.log(isTruncated) // true
```
```js
// Indentation is automatically detected and preserved
const jsonString = JSON.stringify({ a: 'one', b: 'two' }, undefined, 2)
console.log(jsonString)
// '{
// "a": "one",
// "b": "two"
// }' (30 bytes)
console.log(truncateJson(jsonString, 25).jsonString)
// '{
// "a": "one"
// }' (16 bytes)
```
```js
// The top-level value can be any JSON type, not only objects or arrays
const jsonString = JSON.stringify('This is an example top-level string')
console.log(truncateJson(jsonString, 25).jsonString)
// '"This is an example t..."' (25 bytes)
```
# Install
```bash
npm install truncate-json
```
This package works in both Node.js >=18.18.0 and
[browsers](https://raw.githubusercontent.com/ehmicky/dev-tasks/main/src/browserslist).
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# API
## truncateJson(jsonString, maxSize)
`jsonString` `string`\
`maxSize` `number`\
_Return value_: [`object`](#return-value)
Truncates a JSON string to `maxSize` bytes.
Any object property or array item beyond the `maxSize` limit is completely
omitted. Strings are not truncated, except when at the top-level.
### Return value
The return value is an object with the following properties.
#### jsonString
_Type_: `string`
`jsonString` after truncation has been applied.
#### truncatedProps
_Type_: `object[]`
List of properties having been truncated/omitted.
##### truncatedProps[*].path
_Type_: `Array`
Property path. This is an array of property keys and/or array indices.
##### truncatedProps[*].value
_Type_: `JsonValue`
Property value.
# Related projects
- [`is-json-value`](https://github.com/ehmicky/is-json-value): Check if a value
is valid JSON
- [`safe-json-value`](https://github.com/ehmicky/safe-json-value): ⛑️ JSON
serialization should never fail
- [`guess-json-indent`](https://github.com/ehmicky/guess-json-indent): Guess the
indentation of a JSON string
- [`string-byte-length`](https://github.com/ehmicky/string-byte-length): Get the
UTF-8 byte length of a string
- [`string-byte-slice`](https://github.com/ehmicky/string-byte-slice): Like
`string.slice()` but bytewise
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's `Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
[guidelines](CONTRIBUTING.md). Pull requests are welcome!