npmpackage.info

Gathering detailed insights and metrics for lz-string

lz-string

LZ-based compression algorithm for JavaScript

1.5.0

4,136

MIT

TypeScript

1,543,674,456 4.3

Installations

npm install lz-string

Pull Requests

Open

12

Total

124

Closed

65

Merged

47

Issues

Open

41

Total

145

Closed

104

Releases

Typescript conversion and bundler updates

2.0.0-rc.0

Published on 20 Jun 2023

Changed to MIT license

1.4.5

Published on 20 Jun 2023

Minified version

1.5.0

Published on 20 Jun 2023

Fix for IE6&7

1.4.4

Published on 25 May 2015

amd loaders code and typescript support

1.4.3

Published on 26 Apr 2015

Bugfix in decompressFromEncodedURIComponent

1.4.2

Published on 25 Mar 2015

View all 15 releases

Developer

pieroxy

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

16.19.1

NPM Version

8.19.3 Statistics

4,136 Stars

248 Commits

569 Forks

87 Watching

9 Branches

28 Contributors

Updated on 28 Nov 2024

Languages

TypeScript (77.12%)

Shell (14.81%)

JavaScript (8.07%)

Total Downloads

Cumulative downloads

Total Downloads

1,543,674,456

Last day

-6.7%

2,287,377

Compared to previous day

Last week

2.4%

12,868,021

Compared to previous week

Last month

7.5%

53,946,626

Compared to previous month

Last year

21.4%

568,770,787

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

lz-string

LZ-based compression algorithm for JavaScript

[!IMPORTANT] The file layout has changed in version 2, this is now a joint commonjs / esmodule project so modern build tools should be happy with it, but if importing a file directly (such as in a direct javascript project) it is important to use the correct one.

[!TIP] The "old style" minified AMD file is available as dist/index.umd.js via various CDNs or package managers.

Install via npm

1$ npm install -g lz-string
2$ lz-string input.txt > output.txt

Home page

Home page for this program with examples, documentation and a live demo: http://pieroxy.net/blog/pages/lz-string/index.html

Command line

If installed globally there is a command line tool available, and a test suite that can use it to show things are working properly. If other langauges build a command line tool that supports the same arguments then the test suite can be run against them too.

1$ lz-string -h
2Usage: cli [options] [input-file]
3
4Use lz-string to compress or decompress a file
5
6Arguments:
7  input-file                  file to process, if no file then read from stdin
8
9Options:
10  -V, --version               output the version number
11  -d, --decompress            if unset then this will compress
12  -e, --encoder <type>        character encoding to use (choices: "base64", "encodeduri", "raw", "uint8array", "utf16", default: "raw")
13  -v, --verify                verify before returning (default: true)
14  -b, --binary <file>         lz-string binary to use (default: "../dist/index.js")
15  -l, --legacy                use legacy mode where uint8array decompression must be an even length
16  -o, --output <output-file>  output file, otherwise write to stdout
17  -q, --quiet                 don't print any error messages
18  -h, --help                  display help for command

Other languages

This lib has numerous ports to other languages, for server side processing, mostly. Here they are:

[!CAUTION] These are all developed separately, so if you are using two versions to transfer data (such as a client and server version) it is important to check that they are compatible and have identical behaviours on the data!

[!NOTE] Version 1.3.8 of this package had a slight change in the encoding which might impact compatibility.

Java: by Diogo Duailibe
Java: by rufushuang, with base64 support and better performances
C#: by Jawa-the-Hutt
C#: by kreudom, another implementation in C#, more up to date
PHP: by nullpunkt
Python3: by eduardtomasek
Another Python: by marcel-dancak
Ruby by Altivi
Go I helped a friend to write a Go implementation of the decompression algorithm
Go Austin wrote the decompression part as well
Go by daku10, another implementation supports multiple encoding formats and can be used as a CLI tool
Elixir by Michael Shapiro
C++/QT by AmiArt
C++ by Andrey Krasnov, another implementation in C++11
VB.NET by gsemac
Salesforce Apex (Java like language): bilal did the port
Kotlin: from Zen Liu
Dart: from skipness
Haxe: from markknol
Rust: from adumbidiot

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:129: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:130: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:94: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:115: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/pieroxy/lz-string/ci.yml/master?enable=pin
Warn: npmCommand not pinned by hash: test/profiles/legacy.sh:6
Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 4 out of 5 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More