JSONCrush

The JSCrush algorithm is optimized for URI-encoded JSON strings. It achieves compression through several mechanisms:

• Substring Elimination: Similar to the zip algorithm, it eliminates repeated substrings.
• Character Swapping: It processes strings to swap common JSON characters with characters that do not require escaping in a URL.
• Delimiter Usage: It uses the \u0001 (start of heading) character as a delimiter, which is removed during processing.

Performance Considerations:

• The algorithm is highly efficient for most use cases.
• It may become slow when processing very long strings (exceeding 10,000 characters).

You can install the jsoncrush package using npm to add compression capabilities to your project.

npm install jsoncrush

JSONCrush provides two primary methods for handling JSON compression: crush() to compress a JSON string and uncrush() to restore it.

Important Note on URLs: If you intend to use the crushed string in a URL, you must wrap the result in encodeURIComponent() to ensure special characters are properly escaped for the browser.

The uncrush method reverses the compression performed by crush, restoring the original JSON string.

Parameters:

• string (string): The compressed, URL-friendly string.

Returns:

• string: The original, uncompressed JSON string.

The crush method compresses a JSON string into a shorter, URL-friendly string by replacing repeated substrings with single characters and swapping common JSON characters for less frequent ones. This is ideal for reducing the size of data passed in URLs.

Parameters:

• string (string): The JSON string to compress.
• maxSubstringLength (number, optional): The maximum length of substrings to consider for replacement. Defaults to 50.

Returns:

• string: A compressed, URL-friendly string. Note that the output string is appended with an underscore _ to help with link recognition.