canirequire

canirequire › CommonJS › lz-string

Is lz-string ESM-only? Can you require() it?

LZ-based compression algorithm

Last verified Sep 9, 2026 against lz-string@1.5.0. Markdown · JSON

CommonJS CommonJS — require() works on every Node.js version we test

lz-string ships CommonJS only. require("lz-string") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. import "lz-string" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.

What to do

  1. require("lz-string") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun.
  2. From ES modules use the default import: import lzString from "lz-string"; then destructure. Named imports only work when Node.js can statically detect the exports.
  3. TypeScript: types are bundled; install nothing extra.
Latest
1.5.0 (Mar 4, 2023)
Module format
CommonJS
Last CommonJS version
1.5.0
TypeScript types
Bundled
Node engines
not declared
Weekly downloads
57.1M
License
MIT

Does lz-string@1.5.0 actually load? Runtime test results

Installed and executed on Sep 9, 2026 with require("lz-string") from a CommonJS file and import "lz-string" from an ES module.

Runtimerequire("lz-string")import "lz-string"
Node.js 18✓ works✓ works
Node.js 20✓ works✓ works
Node.js 22✓ works✓ works
Node.js 24✓ works✓ works
Node.js 26✓ works✓ works
Bun 1.4.0✓ works✓ works

How to import lz-string

ES modules (import)

import lzString from "lz-string";

Named imports from a CommonJS package only work when Node.js can statically detect them. If a named import fails, use the default import and destructure.

CommonJS (require)

const lzString = require("lz-string");

Module format by version

Derived from the type, main and exports fields of every stable release on npm, corrected where a runtime test of that version contradicted them (9 versions; the newest 9 shown).

VersionsFormatFirst published
1.3.3 – 1.5.0CommonJSOct 27, 2013

Frequently asked

Is lz-string ESM-only?

lz-string@1.5.0 is a CommonJS package. lz-string ships CommonJS only. require("lz-string") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. import "lz-string" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.

Can I import lz-string with ES module syntax?

Yes. import lzString from "lz-string" works in Node.js and Bun because they support importing CommonJS modules. Named imports work only when Node.js can statically detect the exports.

Does lz-string work in Bun?

Yes. import "lz-string" loaded successfully in Bun 1.4.0 on Sep 9, 2026.

Does lz-string ship TypeScript types?

Yes. lz-string bundles its own type declarations; no @types package is needed.

Links

Other commonjs packages

Similar popularity