Skip to content

docs: add deprecation notice recommending @vekexasia/bigint-buffer2 #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vekexasia wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add deprecation notice recommending @vekexasia/bigint-buffer2 #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
# 💪🔢 bigint-buffer: Buffer Utilities for TC39 BigInt Proposal
# 💪🔢 bigint-buffer: Buffer Utilities for TC39 BigInt Proposal

> **⚠️ DEPRECATION NOTICE**
>
> This package is **no longer maintained** and contains a known security vulnerability ([CVE-2025-3194](https://security.snyk.io/vuln/SNYK-JS-BIGINTBUFFER-3364597)).
>
> Please migrate to **[@vekexasia/bigint-buffer2](https://www.npmjs.com/package/@vekexasia/bigint-buffer2)**, a modern, actively maintained replacement that:
> - Fixes all known security vulnerabilities (CVE-2025-3194, issues #40, #59, #12, #22)
> - Uses Rust native bindings (via napi-rs) instead of deprecated N-API/node-gyp
> - Provides full browser support with automatic JS fallback
> - Supports both ESM and CommonJS module formats
> - Includes TypeScript types out of the box
> - Offers additional features: signed integer support, `toBufferBEInto`/`toBufferLEInto` for zero-allocation writes
>
> ```bash
> npm install @vekexasia/bigint-buffer2
> ```
>
> The API is fully compatible - just update your imports:
> ```typescript
> // Before
> import { toBigIntBE, toBufferBE } from 'bigint-buffer';
> // After
> import { toBigIntBE, toBufferBE } from '@vekexasia/bigint-buffer2';
> ```

[![NPM Package](https://img.shields.io/npm/v/bigint-buffer.svg?style=flat-square)](https://www.npmjs.org/package/bigint-buffer)
[![Build Status](https://img.shields.io/travis/com/no2chem/bigint-buffer.svg?branch=master&style=flat-square)](https://travis-ci.com/no2chem/bigint-buffer)
[![Coverage Status](https://img.shields.io/coveralls/no2chem/bigint-buffer.svg?style=flat-square)](https://coveralls.io/r/no2chem/bigint-buffer)
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "bigint-buffer",
"version": "1.1.5",
"description": "bigint to buffer conversion with native support",
"description": "[DEPRECATED - use @vekexasia/bigint-buffer2] bigint to buffer conversion with native support",
"main": "dist/node.js",
"browser": {
"./dist/node.js": "./dist/browser.js"
Expand Down