feat: implement FastAPI service with device-locked automation for Shopee commissions and Facebook commenting
This commit is contained in:
Victor Phan
@@ -0,0 +1,15 @@
|
|||||||
|
let groups = [];
|
||||||
|
let links = document.querySelectorAll('a[href*="/groups/"]');
|
||||||
|
links.forEach(a => {
|
||||||
|
let url = a.href.split('?')[0];
|
||||||
|
let name = a.innerText.trim();
|
||||||
|
// Lọc ra các nhóm hợp lệ (có tên và đúng định dạng)
|
||||||
|
if(name && !name.includes("Joined") && url.includes("facebook.com/groups/")) {
|
||||||
|
let groupId = url.split('/groups/')[1].replace('/', '');
|
||||||
|
groups.push(name + "\t" + groupId);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
// Lọc trùng lặp và in ra màn hình
|
||||||
|
let uniqueGroups = [...new Set(groups)];
|
||||||
|
console.log("TÊN NHÓM \t GROUP ID/LINK");
|
||||||
|
console.log(uniqueGroups.join('\n'));
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
{"web":{"client_id":"745351236177-ibrcl3j2d9oi2malj3fpatfu6il2290b.apps.googleusercontent.com","project_id":"affilatebot","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_secret":"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","redirect_uris":["https://affiliate.victorphan.net/rest/oauth2-credential/callback"]}}
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
Ăn vặt vũng tàu 24/25, 1497333118553115
|
||||||
|
Cần Thơ măm măm 24h., 572825778143458
|
||||||
|
Thanh lý mua bán đồ, 629660232000071
|
||||||
|
CHỢ ĐỒ CŨ-HÀNG, 5116351588414894
|
||||||
|
Chợ Cà Mau, 3421649678115956
|
||||||
|
ĂN VẶT CẦN THƠ 24H, 173706033367028
|
||||||
|
Ăn Vặt Sóc Trăng, 848035632341282
|
||||||
|
Cần Thơ Măm Măm 24/24, 2370776542951057
|
||||||
|
Chợ mua bán đồ cũ 430296077181226
|
||||||
|
Chợ Cà Mau, 338006706614899
|
||||||
|
Tôi Dân Cà Mau, 3110438062542965
|
||||||
|
Chợ Cà Mau, 596173160452194
|
||||||
|
Cộng Đồng Affiliate Shopee Lớn Nhất Tại Việt Nam, 242605124320242
|
||||||
|
Affiliate Shopee - Nơi rải link Tiếp Thị Shopee, 421826749413367
|
||||||
|
Affiliate Shopee Nhập Môn, 473456827330829
|
||||||
|
Kinh Nghiệm Du Lịch Đà Nẵng - Review Đà Nẵng Ăn gì, Ở Đâu, reviewdanang2025
|
||||||
|
RẠCH GIÁ TẤT TẦN TẬT, rachgiatattantat
|
||||||
|
CHỢ CAO LÃNH - ĐỒNG THÁP, 655766718454442
|
||||||
|
Ăn vặt uy tín Long Xuyên, anvatuytinlongxuyenreal
|
||||||
|
Review Đà Lạt - Homestay, Khách Sạn, Villa Đà Lạt Đẹp View Đồi Núi Săn Mây, reviewdalat.homestaydalat
|
||||||
|
Hóng Hớt Cần Thơ, honghotcantho123
|
||||||
|
ĂN UỐNG TÂN AN - LONG AN 🥑🎂🍓🍔🥭🍰, 1749573821890252
|
||||||
|
Ăn Vặt Online Trà Vinh 962731445405177
|
||||||
|
Tâm Sự, Tư Vấn Tình Yêu, Hôn Nhân & Gia Đình 🇻🇳, 328562636360308
|
||||||
|
Tôi Dân Cà Mau, 3110438062542965
|
||||||
|
Đăkmil Quê Ta, dakmilquetoi
|
||||||
|
Khách Sạn giá rẻ Vũng Tàu, 1207619936588032
|
||||||
|
Săn Sale Link kiện PC Shopee và Lazada, 1014900549635958
|
||||||
|
Ăn Vặt Châu Đốc, 1359322700819562
|
||||||
|
RẢI LINK SHOPEE AFFILIATE, 7782475288460301
|
||||||
|
Review Đà Nẵng, 597569737344033
|
||||||
|
Tâm Sự Ngành Nail, 370491764306206
|
||||||
|
VŨNG TÀU REVIEW TẤT TẦN TẬT ✅, 195799853355650
|
||||||
|
REVIEW DU LỊCH ĐÀ NẴNG, 181607847304285
|
||||||
|
CỘNG ĐỒNG RẠCH GIÁ AN GIANG KIÊN GIANG, 3736501113143492
|
||||||
|
CHỢ CAO LÃNH, 426831766836573
|
||||||
|
ĂN VẶT KCN LONG HẬU-THỦ THỪA-LONG AN, 3710883445705693
|
||||||
|
Chợ Trà Vinh, 511803968893402
|
||||||
|
Review Đà Lạt - Homestay Đà Lạt, Khách Sạn, Villa Đà Lạt Nguyên Căn Giá Rẻ reviewdalathomestaygiareviewdep
|
||||||
|
Ăn Vặt Uy Tín Long Xuyên, 862910935508907
|
||||||
|
Ăn Vặt Sóc Trăng, 417603265861589
|
||||||
|
Ăn Vặt Uy Tín Long Xuyên, 228858165051760
|
||||||
|
ăn vặt kcn giao long, 644273129041924
|
||||||
|
Affiliate Shopee - Rải Link Tiếp Thị Liên Kết Shopee Free, 707398030832550
|
||||||
|
Học Nails , Nơi Dạy Nail Uy Tín ✅, 1880877502165058
|
||||||
|
ĂN VẶT VŨNG TÀU ( SHIP LIỀN ), anvatvungtau1
|
||||||
|
Ăn vặt Cao Lãnh, 135165835217887
|
||||||
|
ĂN VẶT VĨNH LONG (CÓ SHIP), 805246494950207
|
||||||
|
Chợ Rạch Sỏi - Tỉnh Kiên Giang, chominhluong
|
||||||
|
Thanh lý đồ Cà Mau ✅, 332839668362355
|
||||||
|
Đà Lạt Review Tất Tần Tật DALATREVIEW
|
||||||
|
Hội Kiếm Tiền Shopee Affiliate, 392859729845376
|
||||||
|
Tâm Sự Hôn Nhân Và Gia Đình, 866588296869197
|
||||||
|
TÂM SỰ EVA- TƯ VẤN TÂM LÝ, HÔN NHÂN , GIA ĐÌNH, 7079703495475311
|
||||||
|
Ăn Vặt Online Trà Vinh, 615659449448127
|
||||||
|
Review Đà Lạt - Homestay, Khách Sạn, Villa Đà Lạt Đẹp View Đồi Núi Săn Mây, 959914531041743
|
||||||
|
CỘNG ĐỒNG RẠCH GIÁ AN GIANG KIÊN GIANG, 3736501113143492
|
||||||
|
CHỢ ĐỒ CŨ-HÀNG THANH LÝ CẦN THƠ, 5116351588414894
|
||||||
|
CHỢ CẦN THƠ, 1876611229179972
|
||||||
|
Chợ Cần Thơ - Mua Bán Online chocanthoofficial
|
||||||
|
Chợ Tốt Cần Thơ ✅ chtotcantho
|
||||||
|
Chợ Ăn Vặt Đại Lãnh, 283033250258962
|
||||||
|
Chợ Cao Lãnh - Tỉnh Đồng Tháp, 1187789018470634
|
||||||
|
CHỢ ONLINE ĐỒNG THÁP, 1054187581389446
|
||||||
|
ăn vặt Sa Đéc, 136406967016411
|
||||||
|
CHỢ CAO LÃNH - ĐỒNG THÁP, 2348431725348493
|
||||||
|
Ăn Uống Đồng Tháp, 353231975532723
|
||||||
|
Ăn Vặt Lai Vung Đồng Tháp, 2261761367369455
|
||||||
|
Ăn Vặt Online Cái Tàu Hạ, Đồng Tháp — Vĩnh Long, 166024604043987
|
||||||
|
RAO VẶT LẤP VÒ - ĐỒNG THÁP, raovatlapvodongthap
|
||||||
|
Ăn Uống Cao Lãnh, anvatcaolanh1
|
||||||
|
Cộng Đồng Rao Vặt Đồng Tháp, cdrvdongthap
|
||||||
|
Ăn Vặt Cao Lãnh, hongbiendongthap
|
||||||
|
ĂN VẶT CHỢ GẠO MỸ THO ĐỒNG THÁP ✅, anvatdongthapshiplien
|
||||||
|
Chợ Đồng Tháp ✅( Chợ Đồng Tháp Online ), 772470474858678
|
||||||
|
Ăn Vặt Cao Lãnh, 704426995252185
|
||||||
|
CHỢ ĐỒNG THÁP, 1154424565221508
|
||||||
|
Chợ Tháp Mười - Đồng Tháp, 1663373727229050
|
||||||
|
Ăn Vặt Cao Lãnh, anvatcaolanh2
|
||||||
|
Ăn Vặt Cao Lãnh, 271029338343387
|
||||||
|
ĂN VẶT TRÀM CHIM - ĐỔNG THÁP, 232330018803497
|
||||||
|
ĂN VẶT TP CAO LÃNH, 956409425224117
|
||||||
|
CHỢ MỸ AN THÁP MƯỜI ĐỒNG THÁP, 1461095211123439
|
||||||
|
Ăn Vặt. Đồng Tháp (KV Cao Lãnh_Sa Đéc), 883127661805353
|
||||||
|
ĂN VẶT MỸ AN-THÁP MƯỜI, 309392377707744
|
||||||
|
Đồ Ăn Vặt Phú Hựu (Châu Thành - Đồng Tháp), 998378524283834
|
||||||
|
Ăn Vặt Sa Đéc, 2771740649687097
|
||||||
|
Ăn Uống Vặt Sa Đéc, 1678311673584109
|
||||||
|
Review ăn uống Cao Lãnh - Đồng Tháp, 999963175131213
|
||||||
|
Ăn Vặt - Nha Mân- Châu thành, Đồng tháp, 222119523220787
|
||||||
|
Ăn Vặt Tân Hồng Đồng Tháp, 1962459277563519
|
||||||
|
Ăn Vặt - Đồ Uống 🍪🌮🍔 SA ĐÉC, ĐỒNG THÁP, 2839443379519183
|
||||||
|
Ăn & Uống Mỹ An - Tháp Mười - Đồng Tháp, 910566953378204
|
||||||
|
ĂN VẶT ĐỒNG THÁP - ship đồ ăn Đồng Tháp, 423801127771828
|
||||||
|
ĂN SẬP ĐỒNG THÁP, ansapdongthap
|
||||||
-16
@@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
||||||
|
|
||||||
case `uname` in
|
|
||||||
*CYGWIN*|*MINGW*|*MSYS*)
|
|
||||||
if command -v cygpath > /dev/null 2>&1; then
|
|
||||||
basedir=`cygpath -w "$basedir"`
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -x "$basedir/node" ]; then
|
|
||||||
exec "$basedir/node" "$basedir/../semver/bin/semver.js" "$@"
|
|
||||||
else
|
|
||||||
exec node "$basedir/../semver/bin/semver.js" "$@"
|
|
||||||
fi
|
|
||||||
-17
@@ -1,17 +0,0 @@
|
|||||||
@ECHO off
|
|
||||||
GOTO start
|
|
||||||
:find_dp0
|
|
||||||
SET dp0=%~dp0
|
|
||||||
EXIT /b
|
|
||||||
:start
|
|
||||||
SETLOCAL
|
|
||||||
CALL :find_dp0
|
|
||||||
|
|
||||||
IF EXIST "%dp0%\node.exe" (
|
|
||||||
SET "_prog=%dp0%\node.exe"
|
|
||||||
) ELSE (
|
|
||||||
SET "_prog=node"
|
|
||||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
|
||||||
)
|
|
||||||
|
|
||||||
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\semver\bin\semver.js" %*
|
|
||||||
-28
@@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env pwsh
|
|
||||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
|
||||||
|
|
||||||
$exe=""
|
|
||||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
|
||||||
# Fix case when both the Windows and Linux builds of Node
|
|
||||||
# are installed in the same directory
|
|
||||||
$exe=".exe"
|
|
||||||
}
|
|
||||||
$ret=0
|
|
||||||
if (Test-Path "$basedir/node$exe") {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "$basedir/node$exe" "$basedir/../semver/bin/semver.js" $args
|
|
||||||
} else {
|
|
||||||
& "$basedir/node$exe" "$basedir/../semver/bin/semver.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
} else {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "node$exe" "$basedir/../semver/bin/semver.js" $args
|
|
||||||
} else {
|
|
||||||
& "node$exe" "$basedir/../semver/bin/semver.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
}
|
|
||||||
exit $ret
|
|
||||||
-16
@@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
||||||
|
|
||||||
case `uname` in
|
|
||||||
*CYGWIN*|*MINGW*|*MSYS*)
|
|
||||||
if command -v cygpath > /dev/null 2>&1; then
|
|
||||||
basedir=`cygpath -w "$basedir"`
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
if [ -x "$basedir/node" ]; then
|
|
||||||
exec "$basedir/node" "$basedir/../tldts/bin/cli.js" "$@"
|
|
||||||
else
|
|
||||||
exec node "$basedir/../tldts/bin/cli.js" "$@"
|
|
||||||
fi
|
|
||||||
-17
@@ -1,17 +0,0 @@
|
|||||||
@ECHO off
|
|
||||||
GOTO start
|
|
||||||
:find_dp0
|
|
||||||
SET dp0=%~dp0
|
|
||||||
EXIT /b
|
|
||||||
:start
|
|
||||||
SETLOCAL
|
|
||||||
CALL :find_dp0
|
|
||||||
|
|
||||||
IF EXIST "%dp0%\node.exe" (
|
|
||||||
SET "_prog=%dp0%\node.exe"
|
|
||||||
) ELSE (
|
|
||||||
SET "_prog=node"
|
|
||||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
|
||||||
)
|
|
||||||
|
|
||||||
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\tldts\bin\cli.js" %*
|
|
||||||
-28
@@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env pwsh
|
|
||||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
|
||||||
|
|
||||||
$exe=""
|
|
||||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
|
||||||
# Fix case when both the Windows and Linux builds of Node
|
|
||||||
# are installed in the same directory
|
|
||||||
$exe=".exe"
|
|
||||||
}
|
|
||||||
$ret=0
|
|
||||||
if (Test-Path "$basedir/node$exe") {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "$basedir/node$exe" "$basedir/../tldts/bin/cli.js" $args
|
|
||||||
} else {
|
|
||||||
& "$basedir/node$exe" "$basedir/../tldts/bin/cli.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
} else {
|
|
||||||
# Support pipeline input
|
|
||||||
if ($MyInvocation.ExpectingInput) {
|
|
||||||
$input | & "node$exe" "$basedir/../tldts/bin/cli.js" $args
|
|
||||||
} else {
|
|
||||||
& "node$exe" "$basedir/../tldts/bin/cli.js" $args
|
|
||||||
}
|
|
||||||
$ret=$LASTEXITCODE
|
|
||||||
}
|
|
||||||
exit $ret
|
|
||||||
-1076
File diff suppressed because it is too large
Load Diff
-250
@@ -1,250 +0,0 @@
|
|||||||
2.0.0 / 2024-08-31
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Drop node <18 support
|
|
||||||
* deps: mime-types@^3.0.0
|
|
||||||
* deps: negotiator@^1.0.0
|
|
||||||
|
|
||||||
1.3.8 / 2022-02-02
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.34
|
|
||||||
- deps: mime-db@~1.51.0
|
|
||||||
* deps: negotiator@0.6.3
|
|
||||||
|
|
||||||
1.3.7 / 2019-04-29
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: negotiator@0.6.2
|
|
||||||
- Fix sorting charset, encoding, and language with extra parameters
|
|
||||||
|
|
||||||
1.3.6 / 2019-04-28
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.24
|
|
||||||
- deps: mime-db@~1.40.0
|
|
||||||
|
|
||||||
1.3.5 / 2018-02-28
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.18
|
|
||||||
- deps: mime-db@~1.33.0
|
|
||||||
|
|
||||||
1.3.4 / 2017-08-22
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.16
|
|
||||||
- deps: mime-db@~1.29.0
|
|
||||||
|
|
||||||
1.3.3 / 2016-05-02
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.11
|
|
||||||
- deps: mime-db@~1.23.0
|
|
||||||
* deps: negotiator@0.6.1
|
|
||||||
- perf: improve `Accept` parsing speed
|
|
||||||
- perf: improve `Accept-Charset` parsing speed
|
|
||||||
- perf: improve `Accept-Encoding` parsing speed
|
|
||||||
- perf: improve `Accept-Language` parsing speed
|
|
||||||
|
|
||||||
1.3.2 / 2016-03-08
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.10
|
|
||||||
- Fix extension of `application/dash+xml`
|
|
||||||
- Update primary extension for `audio/mp4`
|
|
||||||
- deps: mime-db@~1.22.0
|
|
||||||
|
|
||||||
1.3.1 / 2016-01-19
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.9
|
|
||||||
- deps: mime-db@~1.21.0
|
|
||||||
|
|
||||||
1.3.0 / 2015-09-29
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.7
|
|
||||||
- deps: mime-db@~1.19.0
|
|
||||||
* deps: negotiator@0.6.0
|
|
||||||
- Fix including type extensions in parameters in `Accept` parsing
|
|
||||||
- Fix parsing `Accept` parameters with quoted equals
|
|
||||||
- Fix parsing `Accept` parameters with quoted semicolons
|
|
||||||
- Lazy-load modules from main entry point
|
|
||||||
- perf: delay type concatenation until needed
|
|
||||||
- perf: enable strict mode
|
|
||||||
- perf: hoist regular expressions
|
|
||||||
- perf: remove closures getting spec properties
|
|
||||||
- perf: remove a closure from media type parsing
|
|
||||||
- perf: remove property delete from media type parsing
|
|
||||||
|
|
||||||
1.2.13 / 2015-09-06
|
|
||||||
===================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.6
|
|
||||||
- deps: mime-db@~1.18.0
|
|
||||||
|
|
||||||
1.2.12 / 2015-07-30
|
|
||||||
===================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.4
|
|
||||||
- deps: mime-db@~1.16.0
|
|
||||||
|
|
||||||
1.2.11 / 2015-07-16
|
|
||||||
===================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.3
|
|
||||||
- deps: mime-db@~1.15.0
|
|
||||||
|
|
||||||
1.2.10 / 2015-07-01
|
|
||||||
===================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.2
|
|
||||||
- deps: mime-db@~1.14.0
|
|
||||||
|
|
||||||
1.2.9 / 2015-06-08
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.1
|
|
||||||
- perf: fix deopt during mapping
|
|
||||||
|
|
||||||
1.2.8 / 2015-06-07
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.1.0
|
|
||||||
- deps: mime-db@~1.13.0
|
|
||||||
* perf: avoid argument reassignment & argument slice
|
|
||||||
* perf: avoid negotiator recursive construction
|
|
||||||
* perf: enable strict mode
|
|
||||||
* perf: remove unnecessary bitwise operator
|
|
||||||
|
|
||||||
1.2.7 / 2015-05-10
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: negotiator@0.5.3
|
|
||||||
- Fix media type parameter matching to be case-insensitive
|
|
||||||
|
|
||||||
1.2.6 / 2015-05-07
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.11
|
|
||||||
- deps: mime-db@~1.9.1
|
|
||||||
* deps: negotiator@0.5.2
|
|
||||||
- Fix comparing media types with quoted values
|
|
||||||
- Fix splitting media types with quoted commas
|
|
||||||
|
|
||||||
1.2.5 / 2015-03-13
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.10
|
|
||||||
- deps: mime-db@~1.8.0
|
|
||||||
|
|
||||||
1.2.4 / 2015-02-14
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Support Node.js 0.6
|
|
||||||
* deps: mime-types@~2.0.9
|
|
||||||
- deps: mime-db@~1.7.0
|
|
||||||
* deps: negotiator@0.5.1
|
|
||||||
- Fix preference sorting to be stable for long acceptable lists
|
|
||||||
|
|
||||||
1.2.3 / 2015-01-31
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.8
|
|
||||||
- deps: mime-db@~1.6.0
|
|
||||||
|
|
||||||
1.2.2 / 2014-12-30
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.7
|
|
||||||
- deps: mime-db@~1.5.0
|
|
||||||
|
|
||||||
1.2.1 / 2014-12-30
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.5
|
|
||||||
- deps: mime-db@~1.3.1
|
|
||||||
|
|
||||||
1.2.0 / 2014-12-19
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: negotiator@0.5.0
|
|
||||||
- Fix list return order when large accepted list
|
|
||||||
- Fix missing identity encoding when q=0 exists
|
|
||||||
- Remove dynamic building of Negotiator class
|
|
||||||
|
|
||||||
1.1.4 / 2014-12-10
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.4
|
|
||||||
- deps: mime-db@~1.3.0
|
|
||||||
|
|
||||||
1.1.3 / 2014-11-09
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.3
|
|
||||||
- deps: mime-db@~1.2.0
|
|
||||||
|
|
||||||
1.1.2 / 2014-10-14
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: negotiator@0.4.9
|
|
||||||
- Fix error when media type has invalid parameter
|
|
||||||
|
|
||||||
1.1.1 / 2014-09-28
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: mime-types@~2.0.2
|
|
||||||
- deps: mime-db@~1.1.0
|
|
||||||
* deps: negotiator@0.4.8
|
|
||||||
- Fix all negotiations to be case-insensitive
|
|
||||||
- Stable sort preferences of same quality according to client order
|
|
||||||
|
|
||||||
1.1.0 / 2014-09-02
|
|
||||||
==================
|
|
||||||
|
|
||||||
* update `mime-types`
|
|
||||||
|
|
||||||
1.0.7 / 2014-07-04
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Fix wrong type returned from `type` when match after unknown extension
|
|
||||||
|
|
||||||
1.0.6 / 2014-06-24
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: negotiator@0.4.7
|
|
||||||
|
|
||||||
1.0.5 / 2014-06-20
|
|
||||||
==================
|
|
||||||
|
|
||||||
* fix crash when unknown extension given
|
|
||||||
|
|
||||||
1.0.4 / 2014-06-19
|
|
||||||
==================
|
|
||||||
|
|
||||||
* use `mime-types`
|
|
||||||
|
|
||||||
1.0.3 / 2014-06-11
|
|
||||||
==================
|
|
||||||
|
|
||||||
* deps: negotiator@0.4.6
|
|
||||||
- Order by specificity when quality is the same
|
|
||||||
|
|
||||||
1.0.2 / 2014-05-29
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Fix interpretation when header not in request
|
|
||||||
* deps: pin negotiator@0.4.5
|
|
||||||
|
|
||||||
1.0.1 / 2014-01-18
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Identity encoding isn't always acceptable
|
|
||||||
* deps: negotiator@~0.4.0
|
|
||||||
|
|
||||||
1.0.0 / 2013-12-27
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Genesis
|
|
||||||
-23
@@ -1,23 +0,0 @@
|
|||||||
(The MIT License)
|
|
||||||
|
|
||||||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
|
||||||
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
'Software'), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
||||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
||||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
||||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
||||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
-140
@@ -1,140 +0,0 @@
|
|||||||
# accepts
|
|
||||||
|
|
||||||
[![NPM Version][npm-version-image]][npm-url]
|
|
||||||
[![NPM Downloads][npm-downloads-image]][npm-url]
|
|
||||||
[![Node.js Version][node-version-image]][node-version-url]
|
|
||||||
[![Build Status][github-actions-ci-image]][github-actions-ci-url]
|
|
||||||
[![Test Coverage][coveralls-image]][coveralls-url]
|
|
||||||
|
|
||||||
Higher level content negotiation based on [negotiator](https://www.npmjs.com/package/negotiator).
|
|
||||||
Extracted from [koa](https://www.npmjs.com/package/koa) for general use.
|
|
||||||
|
|
||||||
In addition to negotiator, it allows:
|
|
||||||
|
|
||||||
- Allows types as an array or arguments list, ie `(['text/html', 'application/json'])`
|
|
||||||
as well as `('text/html', 'application/json')`.
|
|
||||||
- Allows type shorthands such as `json`.
|
|
||||||
- Returns `false` when no types match
|
|
||||||
- Treats non-existent headers as `*`
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
This is a [Node.js](https://nodejs.org/en/) module available through the
|
|
||||||
[npm registry](https://www.npmjs.com/). Installation is done using the
|
|
||||||
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ npm install accepts
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
```js
|
|
||||||
var accepts = require('accepts')
|
|
||||||
```
|
|
||||||
|
|
||||||
### accepts(req)
|
|
||||||
|
|
||||||
Create a new `Accepts` object for the given `req`.
|
|
||||||
|
|
||||||
#### .charset(charsets)
|
|
||||||
|
|
||||||
Return the first accepted charset. If nothing in `charsets` is accepted,
|
|
||||||
then `false` is returned.
|
|
||||||
|
|
||||||
#### .charsets()
|
|
||||||
|
|
||||||
Return the charsets that the request accepts, in the order of the client's
|
|
||||||
preference (most preferred first).
|
|
||||||
|
|
||||||
#### .encoding(encodings)
|
|
||||||
|
|
||||||
Return the first accepted encoding. If nothing in `encodings` is accepted,
|
|
||||||
then `false` is returned.
|
|
||||||
|
|
||||||
#### .encodings()
|
|
||||||
|
|
||||||
Return the encodings that the request accepts, in the order of the client's
|
|
||||||
preference (most preferred first).
|
|
||||||
|
|
||||||
#### .language(languages)
|
|
||||||
|
|
||||||
Return the first accepted language. If nothing in `languages` is accepted,
|
|
||||||
then `false` is returned.
|
|
||||||
|
|
||||||
#### .languages()
|
|
||||||
|
|
||||||
Return the languages that the request accepts, in the order of the client's
|
|
||||||
preference (most preferred first).
|
|
||||||
|
|
||||||
#### .type(types)
|
|
||||||
|
|
||||||
Return the first accepted type (and it is returned as the same text as what
|
|
||||||
appears in the `types` array). If nothing in `types` is accepted, then `false`
|
|
||||||
is returned.
|
|
||||||
|
|
||||||
The `types` array can contain full MIME types or file extensions. Any value
|
|
||||||
that is not a full MIME type is passed to `require('mime-types').lookup`.
|
|
||||||
|
|
||||||
#### .types()
|
|
||||||
|
|
||||||
Return the types that the request accepts, in the order of the client's
|
|
||||||
preference (most preferred first).
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Simple type negotiation
|
|
||||||
|
|
||||||
This simple example shows how to use `accepts` to return a different typed
|
|
||||||
respond body based on what the client wants to accept. The server lists it's
|
|
||||||
preferences in order and will get back the best match between the client and
|
|
||||||
server.
|
|
||||||
|
|
||||||
```js
|
|
||||||
var accepts = require('accepts')
|
|
||||||
var http = require('http')
|
|
||||||
|
|
||||||
function app (req, res) {
|
|
||||||
var accept = accepts(req)
|
|
||||||
|
|
||||||
// the order of this list is significant; should be server preferred order
|
|
||||||
switch (accept.type(['json', 'html'])) {
|
|
||||||
case 'json':
|
|
||||||
res.setHeader('Content-Type', 'application/json')
|
|
||||||
res.write('{"hello":"world!"}')
|
|
||||||
break
|
|
||||||
case 'html':
|
|
||||||
res.setHeader('Content-Type', 'text/html')
|
|
||||||
res.write('<b>hello, world!</b>')
|
|
||||||
break
|
|
||||||
default:
|
|
||||||
// the fallback is text/plain, so no need to specify it above
|
|
||||||
res.setHeader('Content-Type', 'text/plain')
|
|
||||||
res.write('hello, world!')
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
res.end()
|
|
||||||
}
|
|
||||||
|
|
||||||
http.createServer(app).listen(3000)
|
|
||||||
```
|
|
||||||
|
|
||||||
You can test this out with the cURL program:
|
|
||||||
```sh
|
|
||||||
curl -I -H'Accept: text/html' http://localhost:3000/
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[MIT](LICENSE)
|
|
||||||
|
|
||||||
[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/accepts/master
|
|
||||||
[coveralls-url]: https://coveralls.io/r/jshttp/accepts?branch=master
|
|
||||||
[github-actions-ci-image]: https://badgen.net/github/checks/jshttp/accepts/master?label=ci
|
|
||||||
[github-actions-ci-url]: https://github.com/jshttp/accepts/actions/workflows/ci.yml
|
|
||||||
[node-version-image]: https://badgen.net/npm/node/accepts
|
|
||||||
[node-version-url]: https://nodejs.org/en/download
|
|
||||||
[npm-downloads-image]: https://badgen.net/npm/dm/accepts
|
|
||||||
[npm-url]: https://npmjs.org/package/accepts
|
|
||||||
[npm-version-image]: https://badgen.net/npm/v/accepts
|
|
||||||
-238
@@ -1,238 +0,0 @@
|
|||||||
/*!
|
|
||||||
* accepts
|
|
||||||
* Copyright(c) 2014 Jonathan Ong
|
|
||||||
* Copyright(c) 2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
|
|
||||||
var Negotiator = require('negotiator')
|
|
||||||
var mime = require('mime-types')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = Accepts
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a new Accepts object for the given req.
|
|
||||||
*
|
|
||||||
* @param {object} req
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
function Accepts (req) {
|
|
||||||
if (!(this instanceof Accepts)) {
|
|
||||||
return new Accepts(req)
|
|
||||||
}
|
|
||||||
|
|
||||||
this.headers = req.headers
|
|
||||||
this.negotiator = new Negotiator(req)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the given `type(s)` is acceptable, returning
|
|
||||||
* the best match when true, otherwise `undefined`, in which
|
|
||||||
* case you should respond with 406 "Not Acceptable".
|
|
||||||
*
|
|
||||||
* The `type` value may be a single mime type string
|
|
||||||
* such as "application/json", the extension name
|
|
||||||
* such as "json" or an array `["json", "html", "text/plain"]`. When a list
|
|
||||||
* or array is given the _best_ match, if any is returned.
|
|
||||||
*
|
|
||||||
* Examples:
|
|
||||||
*
|
|
||||||
* // Accept: text/html
|
|
||||||
* this.types('html');
|
|
||||||
* // => "html"
|
|
||||||
*
|
|
||||||
* // Accept: text/*, application/json
|
|
||||||
* this.types('html');
|
|
||||||
* // => "html"
|
|
||||||
* this.types('text/html');
|
|
||||||
* // => "text/html"
|
|
||||||
* this.types('json', 'text');
|
|
||||||
* // => "json"
|
|
||||||
* this.types('application/json');
|
|
||||||
* // => "application/json"
|
|
||||||
*
|
|
||||||
* // Accept: text/*, application/json
|
|
||||||
* this.types('image/png');
|
|
||||||
* this.types('png');
|
|
||||||
* // => undefined
|
|
||||||
*
|
|
||||||
* // Accept: text/*;q=.5, application/json
|
|
||||||
* this.types(['html', 'json']);
|
|
||||||
* this.types('html', 'json');
|
|
||||||
* // => "json"
|
|
||||||
*
|
|
||||||
* @param {String|Array} types...
|
|
||||||
* @return {String|Array|Boolean}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
Accepts.prototype.type =
|
|
||||||
Accepts.prototype.types = function (types_) {
|
|
||||||
var types = types_
|
|
||||||
|
|
||||||
// support flattened arguments
|
|
||||||
if (types && !Array.isArray(types)) {
|
|
||||||
types = new Array(arguments.length)
|
|
||||||
for (var i = 0; i < types.length; i++) {
|
|
||||||
types[i] = arguments[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// no types, return all requested types
|
|
||||||
if (!types || types.length === 0) {
|
|
||||||
return this.negotiator.mediaTypes()
|
|
||||||
}
|
|
||||||
|
|
||||||
// no accept header, return first given type
|
|
||||||
if (!this.headers.accept) {
|
|
||||||
return types[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
var mimes = types.map(extToMime)
|
|
||||||
var accepts = this.negotiator.mediaTypes(mimes.filter(validMime))
|
|
||||||
var first = accepts[0]
|
|
||||||
|
|
||||||
return first
|
|
||||||
? types[mimes.indexOf(first)]
|
|
||||||
: false
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return accepted encodings or best fit based on `encodings`.
|
|
||||||
*
|
|
||||||
* Given `Accept-Encoding: gzip, deflate`
|
|
||||||
* an array sorted by quality is returned:
|
|
||||||
*
|
|
||||||
* ['gzip', 'deflate']
|
|
||||||
*
|
|
||||||
* @param {String|Array} encodings...
|
|
||||||
* @return {String|Array}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
Accepts.prototype.encoding =
|
|
||||||
Accepts.prototype.encodings = function (encodings_) {
|
|
||||||
var encodings = encodings_
|
|
||||||
|
|
||||||
// support flattened arguments
|
|
||||||
if (encodings && !Array.isArray(encodings)) {
|
|
||||||
encodings = new Array(arguments.length)
|
|
||||||
for (var i = 0; i < encodings.length; i++) {
|
|
||||||
encodings[i] = arguments[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// no encodings, return all requested encodings
|
|
||||||
if (!encodings || encodings.length === 0) {
|
|
||||||
return this.negotiator.encodings()
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.negotiator.encodings(encodings)[0] || false
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return accepted charsets or best fit based on `charsets`.
|
|
||||||
*
|
|
||||||
* Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5`
|
|
||||||
* an array sorted by quality is returned:
|
|
||||||
*
|
|
||||||
* ['utf-8', 'utf-7', 'iso-8859-1']
|
|
||||||
*
|
|
||||||
* @param {String|Array} charsets...
|
|
||||||
* @return {String|Array}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
Accepts.prototype.charset =
|
|
||||||
Accepts.prototype.charsets = function (charsets_) {
|
|
||||||
var charsets = charsets_
|
|
||||||
|
|
||||||
// support flattened arguments
|
|
||||||
if (charsets && !Array.isArray(charsets)) {
|
|
||||||
charsets = new Array(arguments.length)
|
|
||||||
for (var i = 0; i < charsets.length; i++) {
|
|
||||||
charsets[i] = arguments[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// no charsets, return all requested charsets
|
|
||||||
if (!charsets || charsets.length === 0) {
|
|
||||||
return this.negotiator.charsets()
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.negotiator.charsets(charsets)[0] || false
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return accepted languages or best fit based on `langs`.
|
|
||||||
*
|
|
||||||
* Given `Accept-Language: en;q=0.8, es, pt`
|
|
||||||
* an array sorted by quality is returned:
|
|
||||||
*
|
|
||||||
* ['es', 'pt', 'en']
|
|
||||||
*
|
|
||||||
* @param {String|Array} langs...
|
|
||||||
* @return {Array|String}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
Accepts.prototype.lang =
|
|
||||||
Accepts.prototype.langs =
|
|
||||||
Accepts.prototype.language =
|
|
||||||
Accepts.prototype.languages = function (languages_) {
|
|
||||||
var languages = languages_
|
|
||||||
|
|
||||||
// support flattened arguments
|
|
||||||
if (languages && !Array.isArray(languages)) {
|
|
||||||
languages = new Array(arguments.length)
|
|
||||||
for (var i = 0; i < languages.length; i++) {
|
|
||||||
languages[i] = arguments[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// no languages, return all requested languages
|
|
||||||
if (!languages || languages.length === 0) {
|
|
||||||
return this.negotiator.languages()
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.negotiator.languages(languages)[0] || false
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert extnames to mime.
|
|
||||||
*
|
|
||||||
* @param {String} type
|
|
||||||
* @return {String}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
|
|
||||||
function extToMime (type) {
|
|
||||||
return type.indexOf('/') === -1
|
|
||||||
? mime.lookup(type)
|
|
||||||
: type
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if mime is valid.
|
|
||||||
*
|
|
||||||
* @param {String} type
|
|
||||||
* @return {Boolean}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
|
|
||||||
function validMime (type) {
|
|
||||||
return typeof type === 'string'
|
|
||||||
}
|
|
||||||
-47
@@ -1,47 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "accepts",
|
|
||||||
"description": "Higher-level content negotiation",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"contributors": [
|
|
||||||
"Douglas Christopher Wilson <doug@somethingdoug.com>",
|
|
||||||
"Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
|
|
||||||
],
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "jshttp/accepts",
|
|
||||||
"dependencies": {
|
|
||||||
"mime-types": "^3.0.0",
|
|
||||||
"negotiator": "^1.0.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"deep-equal": "1.0.1",
|
|
||||||
"eslint": "7.32.0",
|
|
||||||
"eslint-config-standard": "14.1.1",
|
|
||||||
"eslint-plugin-import": "2.25.4",
|
|
||||||
"eslint-plugin-markdown": "2.2.1",
|
|
||||||
"eslint-plugin-node": "11.1.0",
|
|
||||||
"eslint-plugin-promise": "4.3.1",
|
|
||||||
"eslint-plugin-standard": "4.1.0",
|
|
||||||
"mocha": "9.2.0",
|
|
||||||
"nyc": "15.1.0"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"LICENSE",
|
|
||||||
"HISTORY.md",
|
|
||||||
"index.js"
|
|
||||||
],
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 0.6"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"lint": "eslint .",
|
|
||||||
"test": "mocha --reporter spec --check-leaks --bail test/",
|
|
||||||
"test-ci": "nyc --reporter=lcov --reporter=text npm test",
|
|
||||||
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"content",
|
|
||||||
"negotiation",
|
|
||||||
"accept",
|
|
||||||
"accepts"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2016 Alex Indigo
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
-233
@@ -1,233 +0,0 @@
|
|||||||
# asynckit [](https://www.npmjs.com/package/asynckit)
|
|
||||||
|
|
||||||
Minimal async jobs utility library, with streams support.
|
|
||||||
|
|
||||||
[](https://travis-ci.org/alexindigo/asynckit)
|
|
||||||
[](https://travis-ci.org/alexindigo/asynckit)
|
|
||||||
[](https://ci.appveyor.com/project/alexindigo/asynckit)
|
|
||||||
|
|
||||||
[](https://coveralls.io/github/alexindigo/asynckit?branch=master)
|
|
||||||
[](https://david-dm.org/alexindigo/asynckit)
|
|
||||||
[](https://www.bithound.io/github/alexindigo/asynckit)
|
|
||||||
|
|
||||||
<!-- [](https://www.npmjs.com/package/reamde) -->
|
|
||||||
|
|
||||||
AsyncKit provides harness for `parallel` and `serial` iterators over list of items represented by arrays or objects.
|
|
||||||
Optionally it accepts abort function (should be synchronously return by iterator for each item), and terminates left over jobs upon an error event. For specific iteration order built-in (`ascending` and `descending`) and custom sort helpers also supported, via `asynckit.serialOrdered` method.
|
|
||||||
|
|
||||||
It ensures async operations to keep behavior more stable and prevent `Maximum call stack size exceeded` errors, from sync iterators.
|
|
||||||
|
|
||||||
| compression | size |
|
|
||||||
| :----------------- | -------: |
|
|
||||||
| asynckit.js | 12.34 kB |
|
|
||||||
| asynckit.min.js | 4.11 kB |
|
|
||||||
| asynckit.min.js.gz | 1.47 kB |
|
|
||||||
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ npm install --save asynckit
|
|
||||||
```
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Parallel Jobs
|
|
||||||
|
|
||||||
Runs iterator over provided array in parallel. Stores output in the `result` array,
|
|
||||||
on the matching positions. In unlikely event of an error from one of the jobs,
|
|
||||||
will terminate rest of the active jobs (if abort function is provided)
|
|
||||||
and return error along with salvaged data to the main callback function.
|
|
||||||
|
|
||||||
#### Input Array
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var parallel = require('asynckit').parallel
|
|
||||||
, assert = require('assert')
|
|
||||||
;
|
|
||||||
|
|
||||||
var source = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
|
||||||
, expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
|
|
||||||
, expectedTarget = [ 1, 1, 2, 4, 8, 16, 32, 64 ]
|
|
||||||
, target = []
|
|
||||||
;
|
|
||||||
|
|
||||||
parallel(source, asyncJob, function(err, result)
|
|
||||||
{
|
|
||||||
assert.deepEqual(result, expectedResult);
|
|
||||||
assert.deepEqual(target, expectedTarget);
|
|
||||||
});
|
|
||||||
|
|
||||||
// async job accepts one element from the array
|
|
||||||
// and a callback function
|
|
||||||
function asyncJob(item, cb)
|
|
||||||
{
|
|
||||||
// different delays (in ms) per item
|
|
||||||
var delay = item * 25;
|
|
||||||
|
|
||||||
// pretend different jobs take different time to finish
|
|
||||||
// and not in consequential order
|
|
||||||
var timeoutId = setTimeout(function() {
|
|
||||||
target.push(item);
|
|
||||||
cb(null, item * 2);
|
|
||||||
}, delay);
|
|
||||||
|
|
||||||
// allow to cancel "leftover" jobs upon error
|
|
||||||
// return function, invoking of which will abort this job
|
|
||||||
return clearTimeout.bind(null, timeoutId);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
More examples could be found in [test/test-parallel-array.js](test/test-parallel-array.js).
|
|
||||||
|
|
||||||
#### Input Object
|
|
||||||
|
|
||||||
Also it supports named jobs, listed via object.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var parallel = require('asynckit/parallel')
|
|
||||||
, assert = require('assert')
|
|
||||||
;
|
|
||||||
|
|
||||||
var source = { first: 1, one: 1, four: 4, sixteen: 16, sixtyFour: 64, thirtyTwo: 32, eight: 8, two: 2 }
|
|
||||||
, expectedResult = { first: 2, one: 2, four: 8, sixteen: 32, sixtyFour: 128, thirtyTwo: 64, eight: 16, two: 4 }
|
|
||||||
, expectedTarget = [ 1, 1, 2, 4, 8, 16, 32, 64 ]
|
|
||||||
, expectedKeys = [ 'first', 'one', 'two', 'four', 'eight', 'sixteen', 'thirtyTwo', 'sixtyFour' ]
|
|
||||||
, target = []
|
|
||||||
, keys = []
|
|
||||||
;
|
|
||||||
|
|
||||||
parallel(source, asyncJob, function(err, result)
|
|
||||||
{
|
|
||||||
assert.deepEqual(result, expectedResult);
|
|
||||||
assert.deepEqual(target, expectedTarget);
|
|
||||||
assert.deepEqual(keys, expectedKeys);
|
|
||||||
});
|
|
||||||
|
|
||||||
// supports full value, key, callback (shortcut) interface
|
|
||||||
function asyncJob(item, key, cb)
|
|
||||||
{
|
|
||||||
// different delays (in ms) per item
|
|
||||||
var delay = item * 25;
|
|
||||||
|
|
||||||
// pretend different jobs take different time to finish
|
|
||||||
// and not in consequential order
|
|
||||||
var timeoutId = setTimeout(function() {
|
|
||||||
keys.push(key);
|
|
||||||
target.push(item);
|
|
||||||
cb(null, item * 2);
|
|
||||||
}, delay);
|
|
||||||
|
|
||||||
// allow to cancel "leftover" jobs upon error
|
|
||||||
// return function, invoking of which will abort this job
|
|
||||||
return clearTimeout.bind(null, timeoutId);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
More examples could be found in [test/test-parallel-object.js](test/test-parallel-object.js).
|
|
||||||
|
|
||||||
### Serial Jobs
|
|
||||||
|
|
||||||
Runs iterator over provided array sequentially. Stores output in the `result` array,
|
|
||||||
on the matching positions. In unlikely event of an error from one of the jobs,
|
|
||||||
will not proceed to the rest of the items in the list
|
|
||||||
and return error along with salvaged data to the main callback function.
|
|
||||||
|
|
||||||
#### Input Array
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var serial = require('asynckit/serial')
|
|
||||||
, assert = require('assert')
|
|
||||||
;
|
|
||||||
|
|
||||||
var source = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
|
||||||
, expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
|
|
||||||
, expectedTarget = [ 0, 1, 2, 3, 4, 5, 6, 7 ]
|
|
||||||
, target = []
|
|
||||||
;
|
|
||||||
|
|
||||||
serial(source, asyncJob, function(err, result)
|
|
||||||
{
|
|
||||||
assert.deepEqual(result, expectedResult);
|
|
||||||
assert.deepEqual(target, expectedTarget);
|
|
||||||
});
|
|
||||||
|
|
||||||
// extended interface (item, key, callback)
|
|
||||||
// also supported for arrays
|
|
||||||
function asyncJob(item, key, cb)
|
|
||||||
{
|
|
||||||
target.push(key);
|
|
||||||
|
|
||||||
// it will be automatically made async
|
|
||||||
// even it iterator "returns" in the same event loop
|
|
||||||
cb(null, item * 2);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
More examples could be found in [test/test-serial-array.js](test/test-serial-array.js).
|
|
||||||
|
|
||||||
#### Input Object
|
|
||||||
|
|
||||||
Also it supports named jobs, listed via object.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var serial = require('asynckit').serial
|
|
||||||
, assert = require('assert')
|
|
||||||
;
|
|
||||||
|
|
||||||
var source = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
|
||||||
, expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
|
|
||||||
, expectedTarget = [ 0, 1, 2, 3, 4, 5, 6, 7 ]
|
|
||||||
, target = []
|
|
||||||
;
|
|
||||||
|
|
||||||
var source = { first: 1, one: 1, four: 4, sixteen: 16, sixtyFour: 64, thirtyTwo: 32, eight: 8, two: 2 }
|
|
||||||
, expectedResult = { first: 2, one: 2, four: 8, sixteen: 32, sixtyFour: 128, thirtyTwo: 64, eight: 16, two: 4 }
|
|
||||||
, expectedTarget = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
|
||||||
, target = []
|
|
||||||
;
|
|
||||||
|
|
||||||
|
|
||||||
serial(source, asyncJob, function(err, result)
|
|
||||||
{
|
|
||||||
assert.deepEqual(result, expectedResult);
|
|
||||||
assert.deepEqual(target, expectedTarget);
|
|
||||||
});
|
|
||||||
|
|
||||||
// shortcut interface (item, callback)
|
|
||||||
// works for object as well as for the arrays
|
|
||||||
function asyncJob(item, cb)
|
|
||||||
{
|
|
||||||
target.push(item);
|
|
||||||
|
|
||||||
// it will be automatically made async
|
|
||||||
// even it iterator "returns" in the same event loop
|
|
||||||
cb(null, item * 2);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
More examples could be found in [test/test-serial-object.js](test/test-serial-object.js).
|
|
||||||
|
|
||||||
_Note: Since _object_ is an _unordered_ collection of properties,
|
|
||||||
it may produce unexpected results with sequential iterations.
|
|
||||||
Whenever order of the jobs' execution is important please use `serialOrdered` method._
|
|
||||||
|
|
||||||
### Ordered Serial Iterations
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
For example [compare-property](compare-property) package.
|
|
||||||
|
|
||||||
### Streaming interface
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
## Want to Know More?
|
|
||||||
|
|
||||||
More examples can be found in [test folder](test/).
|
|
||||||
|
|
||||||
Or open an [issue](https://github.com/alexindigo/asynckit/issues) with questions and/or suggestions.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
AsyncKit is licensed under the MIT license.
|
|
||||||
-76
@@ -1,76 +0,0 @@
|
|||||||
/* eslint no-console: "off" */
|
|
||||||
|
|
||||||
var asynckit = require('./')
|
|
||||||
, async = require('async')
|
|
||||||
, assert = require('assert')
|
|
||||||
, expected = 0
|
|
||||||
;
|
|
||||||
|
|
||||||
var Benchmark = require('benchmark');
|
|
||||||
var suite = new Benchmark.Suite;
|
|
||||||
|
|
||||||
var source = [];
|
|
||||||
for (var z = 1; z < 100; z++)
|
|
||||||
{
|
|
||||||
source.push(z);
|
|
||||||
expected += z;
|
|
||||||
}
|
|
||||||
|
|
||||||
suite
|
|
||||||
// add tests
|
|
||||||
|
|
||||||
.add('async.map', function(deferred)
|
|
||||||
{
|
|
||||||
var total = 0;
|
|
||||||
|
|
||||||
async.map(source,
|
|
||||||
function(i, cb)
|
|
||||||
{
|
|
||||||
setImmediate(function()
|
|
||||||
{
|
|
||||||
total += i;
|
|
||||||
cb(null, total);
|
|
||||||
});
|
|
||||||
},
|
|
||||||
function(err, result)
|
|
||||||
{
|
|
||||||
assert.ifError(err);
|
|
||||||
assert.equal(result[result.length - 1], expected);
|
|
||||||
deferred.resolve();
|
|
||||||
});
|
|
||||||
}, {'defer': true})
|
|
||||||
|
|
||||||
|
|
||||||
.add('asynckit.parallel', function(deferred)
|
|
||||||
{
|
|
||||||
var total = 0;
|
|
||||||
|
|
||||||
asynckit.parallel(source,
|
|
||||||
function(i, cb)
|
|
||||||
{
|
|
||||||
setImmediate(function()
|
|
||||||
{
|
|
||||||
total += i;
|
|
||||||
cb(null, total);
|
|
||||||
});
|
|
||||||
},
|
|
||||||
function(err, result)
|
|
||||||
{
|
|
||||||
assert.ifError(err);
|
|
||||||
assert.equal(result[result.length - 1], expected);
|
|
||||||
deferred.resolve();
|
|
||||||
});
|
|
||||||
}, {'defer': true})
|
|
||||||
|
|
||||||
|
|
||||||
// add listeners
|
|
||||||
.on('cycle', function(ev)
|
|
||||||
{
|
|
||||||
console.log(String(ev.target));
|
|
||||||
})
|
|
||||||
.on('complete', function()
|
|
||||||
{
|
|
||||||
console.log('Fastest is ' + this.filter('fastest').map('name'));
|
|
||||||
})
|
|
||||||
// run async
|
|
||||||
.run({ 'async': true });
|
|
||||||
-6
@@ -1,6 +0,0 @@
|
|||||||
module.exports =
|
|
||||||
{
|
|
||||||
parallel : require('./parallel.js'),
|
|
||||||
serial : require('./serial.js'),
|
|
||||||
serialOrdered : require('./serialOrdered.js')
|
|
||||||
};
|
|
||||||
-29
@@ -1,29 +0,0 @@
|
|||||||
// API
|
|
||||||
module.exports = abort;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Aborts leftover active jobs
|
|
||||||
*
|
|
||||||
* @param {object} state - current state object
|
|
||||||
*/
|
|
||||||
function abort(state)
|
|
||||||
{
|
|
||||||
Object.keys(state.jobs).forEach(clean.bind(state));
|
|
||||||
|
|
||||||
// reset leftover jobs
|
|
||||||
state.jobs = {};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Cleans up leftover job by invoking abort function for the provided job id
|
|
||||||
*
|
|
||||||
* @this state
|
|
||||||
* @param {string|number} key - job id to abort
|
|
||||||
*/
|
|
||||||
function clean(key)
|
|
||||||
{
|
|
||||||
if (typeof this.jobs[key] == 'function')
|
|
||||||
{
|
|
||||||
this.jobs[key]();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-34
@@ -1,34 +0,0 @@
|
|||||||
var defer = require('./defer.js');
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = async;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Runs provided callback asynchronously
|
|
||||||
* even if callback itself is not
|
|
||||||
*
|
|
||||||
* @param {function} callback - callback to invoke
|
|
||||||
* @returns {function} - augmented callback
|
|
||||||
*/
|
|
||||||
function async(callback)
|
|
||||||
{
|
|
||||||
var isAsync = false;
|
|
||||||
|
|
||||||
// check if async happened
|
|
||||||
defer(function() { isAsync = true; });
|
|
||||||
|
|
||||||
return function async_callback(err, result)
|
|
||||||
{
|
|
||||||
if (isAsync)
|
|
||||||
{
|
|
||||||
callback(err, result);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
defer(function nextTick_callback()
|
|
||||||
{
|
|
||||||
callback(err, result);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
-26
@@ -1,26 +0,0 @@
|
|||||||
module.exports = defer;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Runs provided function on next iteration of the event loop
|
|
||||||
*
|
|
||||||
* @param {function} fn - function to run
|
|
||||||
*/
|
|
||||||
function defer(fn)
|
|
||||||
{
|
|
||||||
var nextTick = typeof setImmediate == 'function'
|
|
||||||
? setImmediate
|
|
||||||
: (
|
|
||||||
typeof process == 'object' && typeof process.nextTick == 'function'
|
|
||||||
? process.nextTick
|
|
||||||
: null
|
|
||||||
);
|
|
||||||
|
|
||||||
if (nextTick)
|
|
||||||
{
|
|
||||||
nextTick(fn);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
setTimeout(fn, 0);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-75
@@ -1,75 +0,0 @@
|
|||||||
var async = require('./async.js')
|
|
||||||
, abort = require('./abort.js')
|
|
||||||
;
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = iterate;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Iterates over each job object
|
|
||||||
*
|
|
||||||
* @param {array|object} list - array or object (named list) to iterate over
|
|
||||||
* @param {function} iterator - iterator to run
|
|
||||||
* @param {object} state - current job status
|
|
||||||
* @param {function} callback - invoked when all elements processed
|
|
||||||
*/
|
|
||||||
function iterate(list, iterator, state, callback)
|
|
||||||
{
|
|
||||||
// store current index
|
|
||||||
var key = state['keyedList'] ? state['keyedList'][state.index] : state.index;
|
|
||||||
|
|
||||||
state.jobs[key] = runJob(iterator, key, list[key], function(error, output)
|
|
||||||
{
|
|
||||||
// don't repeat yourself
|
|
||||||
// skip secondary callbacks
|
|
||||||
if (!(key in state.jobs))
|
|
||||||
{
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// clean up jobs
|
|
||||||
delete state.jobs[key];
|
|
||||||
|
|
||||||
if (error)
|
|
||||||
{
|
|
||||||
// don't process rest of the results
|
|
||||||
// stop still active jobs
|
|
||||||
// and reset the list
|
|
||||||
abort(state);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
state.results[key] = output;
|
|
||||||
}
|
|
||||||
|
|
||||||
// return salvaged results
|
|
||||||
callback(error, state.results);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Runs iterator over provided job element
|
|
||||||
*
|
|
||||||
* @param {function} iterator - iterator to invoke
|
|
||||||
* @param {string|number} key - key/index of the element in the list of jobs
|
|
||||||
* @param {mixed} item - job description
|
|
||||||
* @param {function} callback - invoked after iterator is done with the job
|
|
||||||
* @returns {function|mixed} - job abort function or something else
|
|
||||||
*/
|
|
||||||
function runJob(iterator, key, item, callback)
|
|
||||||
{
|
|
||||||
var aborter;
|
|
||||||
|
|
||||||
// allow shortcut if iterator expects only two arguments
|
|
||||||
if (iterator.length == 2)
|
|
||||||
{
|
|
||||||
aborter = iterator(item, async(callback));
|
|
||||||
}
|
|
||||||
// otherwise go with full three arguments
|
|
||||||
else
|
|
||||||
{
|
|
||||||
aborter = iterator(item, key, async(callback));
|
|
||||||
}
|
|
||||||
|
|
||||||
return aborter;
|
|
||||||
}
|
|
||||||
-91
@@ -1,91 +0,0 @@
|
|||||||
var streamify = require('./streamify.js')
|
|
||||||
, defer = require('./defer.js')
|
|
||||||
;
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = ReadableAsyncKit;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Base constructor for all streams
|
|
||||||
* used to hold properties/methods
|
|
||||||
*/
|
|
||||||
function ReadableAsyncKit()
|
|
||||||
{
|
|
||||||
ReadableAsyncKit.super_.apply(this, arguments);
|
|
||||||
|
|
||||||
// list of active jobs
|
|
||||||
this.jobs = {};
|
|
||||||
|
|
||||||
// add stream methods
|
|
||||||
this.destroy = destroy;
|
|
||||||
this._start = _start;
|
|
||||||
this._read = _read;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Destroys readable stream,
|
|
||||||
* by aborting outstanding jobs
|
|
||||||
*
|
|
||||||
* @returns {void}
|
|
||||||
*/
|
|
||||||
function destroy()
|
|
||||||
{
|
|
||||||
if (this.destroyed)
|
|
||||||
{
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.destroyed = true;
|
|
||||||
|
|
||||||
if (typeof this.terminator == 'function')
|
|
||||||
{
|
|
||||||
this.terminator();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Starts provided jobs in async manner
|
|
||||||
*
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function _start()
|
|
||||||
{
|
|
||||||
// first argument – runner function
|
|
||||||
var runner = arguments[0]
|
|
||||||
// take away first argument
|
|
||||||
, args = Array.prototype.slice.call(arguments, 1)
|
|
||||||
// second argument - input data
|
|
||||||
, input = args[0]
|
|
||||||
// last argument - result callback
|
|
||||||
, endCb = streamify.callback.call(this, args[args.length - 1])
|
|
||||||
;
|
|
||||||
|
|
||||||
args[args.length - 1] = endCb;
|
|
||||||
// third argument - iterator
|
|
||||||
args[1] = streamify.iterator.call(this, args[1]);
|
|
||||||
|
|
||||||
// allow time for proper setup
|
|
||||||
defer(function()
|
|
||||||
{
|
|
||||||
if (!this.destroyed)
|
|
||||||
{
|
|
||||||
this.terminator = runner.apply(null, args);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
endCb(null, Array.isArray(input) ? [] : {});
|
|
||||||
}
|
|
||||||
}.bind(this));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Implement _read to comply with Readable streams
|
|
||||||
* Doesn't really make sense for flowing object mode
|
|
||||||
*
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function _read()
|
|
||||||
{
|
|
||||||
|
|
||||||
}
|
|
||||||
-25
@@ -1,25 +0,0 @@
|
|||||||
var parallel = require('../parallel.js');
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = ReadableParallel;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Streaming wrapper to `asynckit.parallel`
|
|
||||||
*
|
|
||||||
* @param {array|object} list - array or object (named list) to iterate over
|
|
||||||
* @param {function} iterator - iterator to run
|
|
||||||
* @param {function} callback - invoked when all elements processed
|
|
||||||
* @returns {stream.Readable#}
|
|
||||||
*/
|
|
||||||
function ReadableParallel(list, iterator, callback)
|
|
||||||
{
|
|
||||||
if (!(this instanceof ReadableParallel))
|
|
||||||
{
|
|
||||||
return new ReadableParallel(list, iterator, callback);
|
|
||||||
}
|
|
||||||
|
|
||||||
// turn on object mode
|
|
||||||
ReadableParallel.super_.call(this, {objectMode: true});
|
|
||||||
|
|
||||||
this._start(parallel, list, iterator, callback);
|
|
||||||
}
|
|
||||||
-25
@@ -1,25 +0,0 @@
|
|||||||
var serial = require('../serial.js');
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = ReadableSerial;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Streaming wrapper to `asynckit.serial`
|
|
||||||
*
|
|
||||||
* @param {array|object} list - array or object (named list) to iterate over
|
|
||||||
* @param {function} iterator - iterator to run
|
|
||||||
* @param {function} callback - invoked when all elements processed
|
|
||||||
* @returns {stream.Readable#}
|
|
||||||
*/
|
|
||||||
function ReadableSerial(list, iterator, callback)
|
|
||||||
{
|
|
||||||
if (!(this instanceof ReadableSerial))
|
|
||||||
{
|
|
||||||
return new ReadableSerial(list, iterator, callback);
|
|
||||||
}
|
|
||||||
|
|
||||||
// turn on object mode
|
|
||||||
ReadableSerial.super_.call(this, {objectMode: true});
|
|
||||||
|
|
||||||
this._start(serial, list, iterator, callback);
|
|
||||||
}
|
|
||||||
-29
@@ -1,29 +0,0 @@
|
|||||||
var serialOrdered = require('../serialOrdered.js');
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = ReadableSerialOrdered;
|
|
||||||
// expose sort helpers
|
|
||||||
module.exports.ascending = serialOrdered.ascending;
|
|
||||||
module.exports.descending = serialOrdered.descending;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Streaming wrapper to `asynckit.serialOrdered`
|
|
||||||
*
|
|
||||||
* @param {array|object} list - array or object (named list) to iterate over
|
|
||||||
* @param {function} iterator - iterator to run
|
|
||||||
* @param {function} sortMethod - custom sort function
|
|
||||||
* @param {function} callback - invoked when all elements processed
|
|
||||||
* @returns {stream.Readable#}
|
|
||||||
*/
|
|
||||||
function ReadableSerialOrdered(list, iterator, sortMethod, callback)
|
|
||||||
{
|
|
||||||
if (!(this instanceof ReadableSerialOrdered))
|
|
||||||
{
|
|
||||||
return new ReadableSerialOrdered(list, iterator, sortMethod, callback);
|
|
||||||
}
|
|
||||||
|
|
||||||
// turn on object mode
|
|
||||||
ReadableSerialOrdered.super_.call(this, {objectMode: true});
|
|
||||||
|
|
||||||
this._start(serialOrdered, list, iterator, sortMethod, callback);
|
|
||||||
}
|
|
||||||
-37
@@ -1,37 +0,0 @@
|
|||||||
// API
|
|
||||||
module.exports = state;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates initial state object
|
|
||||||
* for iteration over list
|
|
||||||
*
|
|
||||||
* @param {array|object} list - list to iterate over
|
|
||||||
* @param {function|null} sortMethod - function to use for keys sort,
|
|
||||||
* or `null` to keep them as is
|
|
||||||
* @returns {object} - initial state object
|
|
||||||
*/
|
|
||||||
function state(list, sortMethod)
|
|
||||||
{
|
|
||||||
var isNamedList = !Array.isArray(list)
|
|
||||||
, initState =
|
|
||||||
{
|
|
||||||
index : 0,
|
|
||||||
keyedList: isNamedList || sortMethod ? Object.keys(list) : null,
|
|
||||||
jobs : {},
|
|
||||||
results : isNamedList ? {} : [],
|
|
||||||
size : isNamedList ? Object.keys(list).length : list.length
|
|
||||||
}
|
|
||||||
;
|
|
||||||
|
|
||||||
if (sortMethod)
|
|
||||||
{
|
|
||||||
// sort array keys based on it's values
|
|
||||||
// sort object's keys just on own merit
|
|
||||||
initState.keyedList.sort(isNamedList ? sortMethod : function(a, b)
|
|
||||||
{
|
|
||||||
return sortMethod(list[a], list[b]);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return initState;
|
|
||||||
}
|
|
||||||
-141
@@ -1,141 +0,0 @@
|
|||||||
var async = require('./async.js');
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = {
|
|
||||||
iterator: wrapIterator,
|
|
||||||
callback: wrapCallback
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Wraps iterators with long signature
|
|
||||||
*
|
|
||||||
* @this ReadableAsyncKit#
|
|
||||||
* @param {function} iterator - function to wrap
|
|
||||||
* @returns {function} - wrapped function
|
|
||||||
*/
|
|
||||||
function wrapIterator(iterator)
|
|
||||||
{
|
|
||||||
var stream = this;
|
|
||||||
|
|
||||||
return function(item, key, cb)
|
|
||||||
{
|
|
||||||
var aborter
|
|
||||||
, wrappedCb = async(wrapIteratorCallback.call(stream, cb, key))
|
|
||||||
;
|
|
||||||
|
|
||||||
stream.jobs[key] = wrappedCb;
|
|
||||||
|
|
||||||
// it's either shortcut (item, cb)
|
|
||||||
if (iterator.length == 2)
|
|
||||||
{
|
|
||||||
aborter = iterator(item, wrappedCb);
|
|
||||||
}
|
|
||||||
// or long format (item, key, cb)
|
|
||||||
else
|
|
||||||
{
|
|
||||||
aborter = iterator(item, key, wrappedCb);
|
|
||||||
}
|
|
||||||
|
|
||||||
return aborter;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Wraps provided callback function
|
|
||||||
* allowing to execute snitch function before
|
|
||||||
* real callback
|
|
||||||
*
|
|
||||||
* @this ReadableAsyncKit#
|
|
||||||
* @param {function} callback - function to wrap
|
|
||||||
* @returns {function} - wrapped function
|
|
||||||
*/
|
|
||||||
function wrapCallback(callback)
|
|
||||||
{
|
|
||||||
var stream = this;
|
|
||||||
|
|
||||||
var wrapped = function(error, result)
|
|
||||||
{
|
|
||||||
return finisher.call(stream, error, result, callback);
|
|
||||||
};
|
|
||||||
|
|
||||||
return wrapped;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Wraps provided iterator callback function
|
|
||||||
* makes sure snitch only called once,
|
|
||||||
* but passes secondary calls to the original callback
|
|
||||||
*
|
|
||||||
* @this ReadableAsyncKit#
|
|
||||||
* @param {function} callback - callback to wrap
|
|
||||||
* @param {number|string} key - iteration key
|
|
||||||
* @returns {function} wrapped callback
|
|
||||||
*/
|
|
||||||
function wrapIteratorCallback(callback, key)
|
|
||||||
{
|
|
||||||
var stream = this;
|
|
||||||
|
|
||||||
return function(error, output)
|
|
||||||
{
|
|
||||||
// don't repeat yourself
|
|
||||||
if (!(key in stream.jobs))
|
|
||||||
{
|
|
||||||
callback(error, output);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// clean up jobs
|
|
||||||
delete stream.jobs[key];
|
|
||||||
|
|
||||||
return streamer.call(stream, error, {key: key, value: output}, callback);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Stream wrapper for iterator callback
|
|
||||||
*
|
|
||||||
* @this ReadableAsyncKit#
|
|
||||||
* @param {mixed} error - error response
|
|
||||||
* @param {mixed} output - iterator output
|
|
||||||
* @param {function} callback - callback that expects iterator results
|
|
||||||
*/
|
|
||||||
function streamer(error, output, callback)
|
|
||||||
{
|
|
||||||
if (error && !this.error)
|
|
||||||
{
|
|
||||||
this.error = error;
|
|
||||||
this.pause();
|
|
||||||
this.emit('error', error);
|
|
||||||
// send back value only, as expected
|
|
||||||
callback(error, output && output.value);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// stream stuff
|
|
||||||
this.push(output);
|
|
||||||
|
|
||||||
// back to original track
|
|
||||||
// send back value only, as expected
|
|
||||||
callback(error, output && output.value);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Stream wrapper for finishing callback
|
|
||||||
*
|
|
||||||
* @this ReadableAsyncKit#
|
|
||||||
* @param {mixed} error - error response
|
|
||||||
* @param {mixed} output - iterator output
|
|
||||||
* @param {function} callback - callback that expects final results
|
|
||||||
*/
|
|
||||||
function finisher(error, output, callback)
|
|
||||||
{
|
|
||||||
// signal end of the stream
|
|
||||||
// only for successfully finished streams
|
|
||||||
if (!error)
|
|
||||||
{
|
|
||||||
this.push(null);
|
|
||||||
}
|
|
||||||
|
|
||||||
// back to original track
|
|
||||||
callback(error, output);
|
|
||||||
}
|
|
||||||
-29
@@ -1,29 +0,0 @@
|
|||||||
var abort = require('./abort.js')
|
|
||||||
, async = require('./async.js')
|
|
||||||
;
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports = terminator;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Terminates jobs in the attached state context
|
|
||||||
*
|
|
||||||
* @this AsyncKitState#
|
|
||||||
* @param {function} callback - final callback to invoke after termination
|
|
||||||
*/
|
|
||||||
function terminator(callback)
|
|
||||||
{
|
|
||||||
if (!Object.keys(this.jobs).length)
|
|
||||||
{
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// fast forward iteration index
|
|
||||||
this.index = this.size;
|
|
||||||
|
|
||||||
// abort jobs
|
|
||||||
abort(this);
|
|
||||||
|
|
||||||
// send back results we have so far
|
|
||||||
async(callback)(null, this.results);
|
|
||||||
}
|
|
||||||
-63
@@ -1,63 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "asynckit",
|
|
||||||
"version": "0.4.0",
|
|
||||||
"description": "Minimal async jobs utility library, with streams support",
|
|
||||||
"main": "index.js",
|
|
||||||
"scripts": {
|
|
||||||
"clean": "rimraf coverage",
|
|
||||||
"lint": "eslint *.js lib/*.js test/*.js",
|
|
||||||
"test": "istanbul cover --reporter=json tape -- 'test/test-*.js' | tap-spec",
|
|
||||||
"win-test": "tape test/test-*.js",
|
|
||||||
"browser": "browserify -t browserify-istanbul test/lib/browserify_adjustment.js test/test-*.js | obake --coverage | tap-spec",
|
|
||||||
"report": "istanbul report",
|
|
||||||
"size": "browserify index.js | size-table asynckit",
|
|
||||||
"debug": "tape test/test-*.js"
|
|
||||||
},
|
|
||||||
"pre-commit": [
|
|
||||||
"clean",
|
|
||||||
"lint",
|
|
||||||
"test",
|
|
||||||
"browser",
|
|
||||||
"report",
|
|
||||||
"size"
|
|
||||||
],
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git+https://github.com/alexindigo/asynckit.git"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"async",
|
|
||||||
"jobs",
|
|
||||||
"parallel",
|
|
||||||
"serial",
|
|
||||||
"iterator",
|
|
||||||
"array",
|
|
||||||
"object",
|
|
||||||
"stream",
|
|
||||||
"destroy",
|
|
||||||
"terminate",
|
|
||||||
"abort"
|
|
||||||
],
|
|
||||||
"author": "Alex Indigo <iam@alexindigo.com>",
|
|
||||||
"license": "MIT",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/alexindigo/asynckit/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/alexindigo/asynckit#readme",
|
|
||||||
"devDependencies": {
|
|
||||||
"browserify": "^13.0.0",
|
|
||||||
"browserify-istanbul": "^2.0.0",
|
|
||||||
"coveralls": "^2.11.9",
|
|
||||||
"eslint": "^2.9.0",
|
|
||||||
"istanbul": "^0.4.3",
|
|
||||||
"obake": "^0.1.2",
|
|
||||||
"phantomjs-prebuilt": "^2.1.7",
|
|
||||||
"pre-commit": "^1.1.3",
|
|
||||||
"reamde": "^1.1.0",
|
|
||||||
"rimraf": "^2.5.2",
|
|
||||||
"size-table": "^0.2.0",
|
|
||||||
"tap-spec": "^4.1.1",
|
|
||||||
"tape": "^4.5.1"
|
|
||||||
},
|
|
||||||
"dependencies": {}
|
|
||||||
}
|
|
||||||
-43
@@ -1,43 +0,0 @@
|
|||||||
var iterate = require('./lib/iterate.js')
|
|
||||||
, initState = require('./lib/state.js')
|
|
||||||
, terminator = require('./lib/terminator.js')
|
|
||||||
;
|
|
||||||
|
|
||||||
// Public API
|
|
||||||
module.exports = parallel;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Runs iterator over provided array elements in parallel
|
|
||||||
*
|
|
||||||
* @param {array|object} list - array or object (named list) to iterate over
|
|
||||||
* @param {function} iterator - iterator to run
|
|
||||||
* @param {function} callback - invoked when all elements processed
|
|
||||||
* @returns {function} - jobs terminator
|
|
||||||
*/
|
|
||||||
function parallel(list, iterator, callback)
|
|
||||||
{
|
|
||||||
var state = initState(list);
|
|
||||||
|
|
||||||
while (state.index < (state['keyedList'] || list).length)
|
|
||||||
{
|
|
||||||
iterate(list, iterator, state, function(error, result)
|
|
||||||
{
|
|
||||||
if (error)
|
|
||||||
{
|
|
||||||
callback(error, result);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// looks like it's the last one
|
|
||||||
if (Object.keys(state.jobs).length === 0)
|
|
||||||
{
|
|
||||||
callback(null, state.results);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
state.index++;
|
|
||||||
}
|
|
||||||
|
|
||||||
return terminator.bind(state, callback);
|
|
||||||
}
|
|
||||||
-17
@@ -1,17 +0,0 @@
|
|||||||
var serialOrdered = require('./serialOrdered.js');
|
|
||||||
|
|
||||||
// Public API
|
|
||||||
module.exports = serial;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Runs iterator over provided array elements in series
|
|
||||||
*
|
|
||||||
* @param {array|object} list - array or object (named list) to iterate over
|
|
||||||
* @param {function} iterator - iterator to run
|
|
||||||
* @param {function} callback - invoked when all elements processed
|
|
||||||
* @returns {function} - jobs terminator
|
|
||||||
*/
|
|
||||||
function serial(list, iterator, callback)
|
|
||||||
{
|
|
||||||
return serialOrdered(list, iterator, null, callback);
|
|
||||||
}
|
|
||||||
-75
@@ -1,75 +0,0 @@
|
|||||||
var iterate = require('./lib/iterate.js')
|
|
||||||
, initState = require('./lib/state.js')
|
|
||||||
, terminator = require('./lib/terminator.js')
|
|
||||||
;
|
|
||||||
|
|
||||||
// Public API
|
|
||||||
module.exports = serialOrdered;
|
|
||||||
// sorting helpers
|
|
||||||
module.exports.ascending = ascending;
|
|
||||||
module.exports.descending = descending;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Runs iterator over provided sorted array elements in series
|
|
||||||
*
|
|
||||||
* @param {array|object} list - array or object (named list) to iterate over
|
|
||||||
* @param {function} iterator - iterator to run
|
|
||||||
* @param {function} sortMethod - custom sort function
|
|
||||||
* @param {function} callback - invoked when all elements processed
|
|
||||||
* @returns {function} - jobs terminator
|
|
||||||
*/
|
|
||||||
function serialOrdered(list, iterator, sortMethod, callback)
|
|
||||||
{
|
|
||||||
var state = initState(list, sortMethod);
|
|
||||||
|
|
||||||
iterate(list, iterator, state, function iteratorHandler(error, result)
|
|
||||||
{
|
|
||||||
if (error)
|
|
||||||
{
|
|
||||||
callback(error, result);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
state.index++;
|
|
||||||
|
|
||||||
// are we there yet?
|
|
||||||
if (state.index < (state['keyedList'] || list).length)
|
|
||||||
{
|
|
||||||
iterate(list, iterator, state, iteratorHandler);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// done here
|
|
||||||
callback(null, state.results);
|
|
||||||
});
|
|
||||||
|
|
||||||
return terminator.bind(state, callback);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
* -- Sort methods
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* sort helper to sort array elements in ascending order
|
|
||||||
*
|
|
||||||
* @param {mixed} a - an item to compare
|
|
||||||
* @param {mixed} b - an item to compare
|
|
||||||
* @returns {number} - comparison result
|
|
||||||
*/
|
|
||||||
function ascending(a, b)
|
|
||||||
{
|
|
||||||
return a < b ? -1 : a > b ? 1 : 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* sort helper to sort array elements in descending order
|
|
||||||
*
|
|
||||||
* @param {mixed} a - an item to compare
|
|
||||||
* @param {mixed} b - an item to compare
|
|
||||||
* @returns {number} - comparison result
|
|
||||||
*/
|
|
||||||
function descending(a, b)
|
|
||||||
{
|
|
||||||
return -1 * ascending(a, b);
|
|
||||||
}
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
var inherits = require('util').inherits
|
|
||||||
, Readable = require('stream').Readable
|
|
||||||
, ReadableAsyncKit = require('./lib/readable_asynckit.js')
|
|
||||||
, ReadableParallel = require('./lib/readable_parallel.js')
|
|
||||||
, ReadableSerial = require('./lib/readable_serial.js')
|
|
||||||
, ReadableSerialOrdered = require('./lib/readable_serial_ordered.js')
|
|
||||||
;
|
|
||||||
|
|
||||||
// API
|
|
||||||
module.exports =
|
|
||||||
{
|
|
||||||
parallel : ReadableParallel,
|
|
||||||
serial : ReadableSerial,
|
|
||||||
serialOrdered : ReadableSerialOrdered,
|
|
||||||
};
|
|
||||||
|
|
||||||
inherits(ReadableAsyncKit, Readable);
|
|
||||||
|
|
||||||
inherits(ReadableParallel, ReadableAsyncKit);
|
|
||||||
inherits(ReadableSerial, ReadableAsyncKit);
|
|
||||||
inherits(ReadableSerialOrdered, ReadableAsyncKit);
|
|
||||||
-381
@@ -1,381 +0,0 @@
|
|||||||
#### 9.3.1
|
|
||||||
|
|
||||||
* 11/07/25
|
|
||||||
* [BUGFIX] #388 `toPrecision` fix.
|
|
||||||
|
|
||||||
#### 9.3.0
|
|
||||||
|
|
||||||
* 19/04/25
|
|
||||||
* Refactor type declarations:
|
|
||||||
* Rename *bignumber.d.ts* to *types.d.ts*.
|
|
||||||
* Rename *bignumber.d.cts* to *bignumber.d.ts*.
|
|
||||||
* Add `export as namespace` to *bignumber.d.ts*.
|
|
||||||
* Remove subpath exports from *package.json*.
|
|
||||||
* Refactor named export from *bignumber.d.mts*.
|
|
||||||
* #383 Remove `?` from static `BigNumber` and `default` properties.
|
|
||||||
* Add blank lines after titles in *CHANGELOG.md*.
|
|
||||||
|
|
||||||
#### 9.2.1
|
|
||||||
|
|
||||||
* 08/04/25
|
|
||||||
* #371 #382 Add `BigNumber` as named export.
|
|
||||||
|
|
||||||
#### 9.2.0
|
|
||||||
|
|
||||||
* 03/04/25
|
|
||||||
* #355 Support `BigInt` argument.
|
|
||||||
* #371 Provide separate type definitions for CommonJS and ES modules.
|
|
||||||
* #374 Correct `comparedTo` return type.
|
|
||||||
|
|
||||||
#### 9.1.2
|
|
||||||
|
|
||||||
* 28/08/23
|
|
||||||
* #354 Amend `round` to avoid bug in v8 Maglev compiler.
|
|
||||||
* [BUGFIX] #344 `minimum(0, -0)` should be `-0`.
|
|
||||||
|
|
||||||
#### 9.1.1
|
|
||||||
|
|
||||||
* 04/12/22
|
|
||||||
* #338 [BUGFIX] `exponentiatedBy`: ensure `0**-n === Infinity` for very large `n`.
|
|
||||||
|
|
||||||
#### 9.1.0
|
|
||||||
|
|
||||||
* 08/08/22
|
|
||||||
* #329 Remove `import` example.
|
|
||||||
* #277 Resolve lint warnings and add number `toString` note.
|
|
||||||
* Correct `decimalPlaces()` return type in *bignumber.d.ts*.
|
|
||||||
* Add ES module global `crypto` example.
|
|
||||||
* #322 Add `exports` field to *package.json*.
|
|
||||||
* #251 (#308) Amend *bignumber.d.ts* to allow instantiating a BigNumber without `new`.
|
|
||||||
|
|
||||||
#### 9.0.2
|
|
||||||
|
|
||||||
* 12/12/21
|
|
||||||
* #250 [BUGFIX] Allow use of user-defined alphabet for base 10.
|
|
||||||
* #295 Remove *bignumber.min.js* and amend *README.md*.
|
|
||||||
* Update *.travis.yml* and *LICENCE.md*.
|
|
||||||
|
|
||||||
#### 9.0.1
|
|
||||||
|
|
||||||
* 28/09/20
|
|
||||||
* [BUGFIX] #276 Correct `sqrt` initial estimate.
|
|
||||||
* Update *.travis.yml*, *LICENCE.md* and *README.md*.
|
|
||||||
|
|
||||||
#### 9.0.0
|
|
||||||
|
|
||||||
* 27/05/2019
|
|
||||||
* For compatibility with legacy browsers, remove `Symbol` references.
|
|
||||||
|
|
||||||
#### 8.1.1
|
|
||||||
|
|
||||||
* 24/02/2019
|
|
||||||
* [BUGFIX] #222 Restore missing `var` to `export BigNumber`.
|
|
||||||
* Allow any key in BigNumber.Instance in *bignumber.d.ts*.
|
|
||||||
|
|
||||||
#### 8.1.0
|
|
||||||
|
|
||||||
* 23/02/2019
|
|
||||||
* [NEW FEATURE] #220 Create a BigNumber using `{s, e, c}`.
|
|
||||||
* [NEW FEATURE] `isBigNumber`: if `BigNumber.DEBUG` is `true`, also check that the BigNumber instance is well-formed.
|
|
||||||
* Remove `instanceof` checks; just use `_isBigNumber` to identify a BigNumber instance.
|
|
||||||
* Add `_isBigNumber` to prototype in *bignumber.mjs*.
|
|
||||||
* Add tests for BigNumber creation from object.
|
|
||||||
* Update *API.html*.
|
|
||||||
|
|
||||||
#### 8.0.2
|
|
||||||
|
|
||||||
* 13/01/2019
|
|
||||||
* #209 `toPrecision` without argument should follow `toString`.
|
|
||||||
* Improve *Use* section of *README*.
|
|
||||||
* Optimise `toString(10)`.
|
|
||||||
* Add verson number to API doc.
|
|
||||||
|
|
||||||
#### 8.0.1
|
|
||||||
|
|
||||||
* 01/11/2018
|
|
||||||
* Rest parameter must be array type in *bignumber.d.ts*.
|
|
||||||
|
|
||||||
#### 8.0.0
|
|
||||||
|
|
||||||
* 01/11/2018
|
|
||||||
* [NEW FEATURE] Add `BigNumber.sum` method.
|
|
||||||
* [NEW FEATURE]`toFormat`: add `prefix` and `suffix` options.
|
|
||||||
* [NEW FEATURE] #178 Pass custom formatting to `toFormat`.
|
|
||||||
* [BREAKING CHANGE] #184 `toFraction`: return array of BigNumbers not strings.
|
|
||||||
* [NEW FEATURE] #185 Enable overwrite of `valueOf` to prevent accidental addition to string.
|
|
||||||
* #183 Add Node.js `crypto` requirement to documentation.
|
|
||||||
* [BREAKING CHANGE] #198 Disallow signs and whitespace in custom alphabet.
|
|
||||||
* [NEW FEATURE] #188 Implement `util.inspect.custom` for Node.js REPL.
|
|
||||||
* #170 Make `isBigNumber` a type guard in *bignumber.d.ts*.
|
|
||||||
* [BREAKING CHANGE] `BigNumber.min` and `BigNumber.max`: don't accept an array.
|
|
||||||
* Update *.travis.yml*.
|
|
||||||
* Remove *bower.json*.
|
|
||||||
|
|
||||||
#### 7.2.1
|
|
||||||
|
|
||||||
* 24/05/2018
|
|
||||||
* Add `browser` field to *package.json*.
|
|
||||||
|
|
||||||
#### 7.2.0
|
|
||||||
|
|
||||||
* 22/05/2018
|
|
||||||
* #166 Correct *.mjs* file. Remove extension from `main` field in *package.json*.
|
|
||||||
|
|
||||||
#### 7.1.0
|
|
||||||
|
|
||||||
* 18/05/2018
|
|
||||||
* Add `module` field to *package.json* for *bignumber.mjs*.
|
|
||||||
|
|
||||||
#### 7.0.2
|
|
||||||
|
|
||||||
* 17/05/2018
|
|
||||||
* #165 Bugfix: upper-case letters for bases 11-36 in a custom alphabet.
|
|
||||||
* Add note to *README* regarding creating BigNumbers from Number values.
|
|
||||||
|
|
||||||
#### 7.0.1
|
|
||||||
|
|
||||||
* 26/04/2018
|
|
||||||
* #158 Fix global object variable name typo.
|
|
||||||
|
|
||||||
#### 7.0.0
|
|
||||||
|
|
||||||
* 26/04/2018
|
|
||||||
* #143 Remove global BigNumber from typings.
|
|
||||||
* #144 Enable compatibility with `Object.freeze(Object.prototype)`.
|
|
||||||
* #148 #123 #11 Only throw on a number primitive with more than 15 significant digits if `BigNumber.DEBUG` is `true`.
|
|
||||||
* Only throw on an invalid BigNumber value if `BigNumber.DEBUG` is `true`. Return BigNumber `NaN` instead.
|
|
||||||
* #154 `exponentiatedBy`: allow BigNumber exponent.
|
|
||||||
* #156 Prevent Content Security Policy *unsafe-eval* issue.
|
|
||||||
* `toFraction`: allow `Infinity` maximum denominator.
|
|
||||||
* Comment-out some excess tests to reduce test time.
|
|
||||||
* Amend indentation and other spacing.
|
|
||||||
|
|
||||||
#### 6.0.0
|
|
||||||
|
|
||||||
* 26/01/2018
|
|
||||||
* #137 Implement `APLHABET` configuration option.
|
|
||||||
* Remove `ERRORS` configuration option.
|
|
||||||
* Remove `toDigits` method; extend `precision` method accordingly.
|
|
||||||
* Remove s`round` method; extend `decimalPlaces` method accordingly.
|
|
||||||
* Remove methods: `ceil`, `floor`, and `truncated`.
|
|
||||||
* Remove method aliases: `add`, `cmp`, `isInt`, `isNeg`, `trunc`, `mul`, `neg` and `sub`.
|
|
||||||
* Rename methods: `shift` to `shiftedBy`, `another` to `clone`, `toPower` to `exponentiatedBy`, and `equals` to `isEqualTo`.
|
|
||||||
* Rename methods: add `is` prefix to `greaterThan`, `greaterThanOrEqualTo`, `lessThan` and `lessThanOrEqualTo`.
|
|
||||||
* Add methods: `multipliedBy`, `isBigNumber`, `isPositive`, `integerValue`, `maximum` and `minimum`.
|
|
||||||
* Refactor test suite.
|
|
||||||
* Add *CHANGELOG.md*.
|
|
||||||
* Rewrite *bignumber.d.ts*.
|
|
||||||
* Redo API image.
|
|
||||||
|
|
||||||
#### 5.0.0
|
|
||||||
|
|
||||||
* 27/11/2017
|
|
||||||
* #81 Don't throw on constructor call without `new`.
|
|
||||||
|
|
||||||
#### 4.1.0
|
|
||||||
|
|
||||||
* 26/09/2017
|
|
||||||
* Remove node 0.6 from *.travis.yml*.
|
|
||||||
* Add *bignumber.mjs*.
|
|
||||||
|
|
||||||
#### 4.0.4
|
|
||||||
|
|
||||||
* 03/09/2017
|
|
||||||
* Add missing aliases to *bignumber.d.ts*.
|
|
||||||
|
|
||||||
#### 4.0.3
|
|
||||||
|
|
||||||
* 30/08/2017
|
|
||||||
* Add types: *bignumber.d.ts*.
|
|
||||||
|
|
||||||
#### 4.0.2
|
|
||||||
|
|
||||||
* 03/05/2017
|
|
||||||
* #120 Workaround Safari/Webkit bug.
|
|
||||||
|
|
||||||
#### 4.0.1
|
|
||||||
|
|
||||||
* 05/04/2017
|
|
||||||
* #121 BigNumber.default to BigNumber['default'].
|
|
||||||
|
|
||||||
#### 4.0.0
|
|
||||||
|
|
||||||
* 09/01/2017
|
|
||||||
* Replace BigNumber.isBigNumber method with isBigNumber prototype property.
|
|
||||||
|
|
||||||
#### 3.1.2
|
|
||||||
|
|
||||||
* 08/01/2017
|
|
||||||
* Minor documentation edit.
|
|
||||||
|
|
||||||
#### 3.1.1
|
|
||||||
|
|
||||||
* 08/01/2017
|
|
||||||
* Uncomment `isBigNumber` tests.
|
|
||||||
* Ignore dot files.
|
|
||||||
|
|
||||||
#### 3.1.0
|
|
||||||
|
|
||||||
* 08/01/2017
|
|
||||||
* Add `isBigNumber` method.
|
|
||||||
|
|
||||||
#### 3.0.2
|
|
||||||
|
|
||||||
* 08/01/2017
|
|
||||||
* Bugfix: Possible incorrect value of `ERRORS` after a `BigNumber.another` call (due to `parseNumeric` declaration in outer scope).
|
|
||||||
|
|
||||||
#### 3.0.1
|
|
||||||
|
|
||||||
* 23/11/2016
|
|
||||||
* Apply fix for old ipads with `%` issue, see #57 and #102.
|
|
||||||
* Correct error message.
|
|
||||||
|
|
||||||
#### 3.0.0
|
|
||||||
|
|
||||||
* 09/11/2016
|
|
||||||
* Remove `require('crypto')` - leave it to the user.
|
|
||||||
* Add `BigNumber.set` as `BigNumber.config` alias.
|
|
||||||
* Default `POW_PRECISION` to `0`.
|
|
||||||
|
|
||||||
#### 2.4.0
|
|
||||||
|
|
||||||
* 14/07/2016
|
|
||||||
* #97 Add exports to support ES6 imports.
|
|
||||||
|
|
||||||
#### 2.3.0
|
|
||||||
|
|
||||||
* 07/03/2016
|
|
||||||
* #86 Add modulus parameter to `toPower`.
|
|
||||||
|
|
||||||
#### 2.2.0
|
|
||||||
|
|
||||||
* 03/03/2016
|
|
||||||
* #91 Permit larger JS integers.
|
|
||||||
|
|
||||||
#### 2.1.4
|
|
||||||
|
|
||||||
* 15/12/2015
|
|
||||||
* Correct UMD.
|
|
||||||
|
|
||||||
#### 2.1.3
|
|
||||||
|
|
||||||
* 13/12/2015
|
|
||||||
* Refactor re global object and crypto availability when bundling.
|
|
||||||
|
|
||||||
#### 2.1.2
|
|
||||||
|
|
||||||
* 10/12/2015
|
|
||||||
* Bugfix: `window.crypto` not assigned to `crypto`.
|
|
||||||
|
|
||||||
#### 2.1.1
|
|
||||||
|
|
||||||
* 09/12/2015
|
|
||||||
* Prevent code bundler from adding `crypto` shim.
|
|
||||||
|
|
||||||
#### 2.1.0
|
|
||||||
|
|
||||||
* 26/10/2015
|
|
||||||
* For `valueOf` and `toJSON`, include the minus sign with negative zero.
|
|
||||||
|
|
||||||
#### 2.0.8
|
|
||||||
|
|
||||||
* 2/10/2015
|
|
||||||
* Internal round function bugfix.
|
|
||||||
|
|
||||||
#### 2.0.6
|
|
||||||
|
|
||||||
* 31/03/2015
|
|
||||||
* Add bower.json. Tweak division after in-depth review.
|
|
||||||
|
|
||||||
#### 2.0.5
|
|
||||||
|
|
||||||
* 25/03/2015
|
|
||||||
* Amend README. Remove bitcoin address.
|
|
||||||
|
|
||||||
#### 2.0.4
|
|
||||||
|
|
||||||
* 25/03/2015
|
|
||||||
* Critical bugfix #58: division.
|
|
||||||
|
|
||||||
#### 2.0.3
|
|
||||||
|
|
||||||
* 18/02/2015
|
|
||||||
* Amend README. Add source map.
|
|
||||||
|
|
||||||
#### 2.0.2
|
|
||||||
|
|
||||||
* 18/02/2015
|
|
||||||
* Correct links.
|
|
||||||
|
|
||||||
#### 2.0.1
|
|
||||||
|
|
||||||
* 18/02/2015
|
|
||||||
* Add `max`, `min`, `precision`, `random`, `shiftedBy`, `toDigits` and `truncated` methods.
|
|
||||||
* Add the short-forms: `add`, `mul`, `sd`, `sub` and `trunc`.
|
|
||||||
* Add an `another` method to enable multiple independent constructors to be created.
|
|
||||||
* Add support for the base 2, 8 and 16 prefixes `0b`, `0o` and `0x`.
|
|
||||||
* Enable a rounding mode to be specified as a second parameter to `toExponential`, `toFixed`, `toFormat` and `toPrecision`.
|
|
||||||
* Add a `CRYPTO` configuration property so cryptographically-secure pseudo-random number generation can be specified.
|
|
||||||
* Add a `MODULO_MODE` configuration property to enable the rounding mode used by the `modulo` operation to be specified.
|
|
||||||
* Add a `POW_PRECISION` configuration property to enable the number of significant digits calculated by the power operation to be limited.
|
|
||||||
* Improve code quality.
|
|
||||||
* Improve documentation.
|
|
||||||
|
|
||||||
#### 2.0.0
|
|
||||||
|
|
||||||
* 29/12/2014
|
|
||||||
* Add `dividedToIntegerBy`, `isInteger` and `toFormat` methods.
|
|
||||||
* Remove the following short-forms: `isF`, `isZ`, `toE`, `toF`, `toFr`, `toN`, `toP`, `toS`.
|
|
||||||
* Store a BigNumber's coefficient in base 1e14, rather than base 10.
|
|
||||||
* Add fast path for integers to BigNumber constructor.
|
|
||||||
* Incorporate the library into the online documentation.
|
|
||||||
|
|
||||||
#### 1.5.0
|
|
||||||
|
|
||||||
* 13/11/2014
|
|
||||||
* Add `toJSON` and `decimalPlaces` methods.
|
|
||||||
|
|
||||||
#### 1.4.1
|
|
||||||
|
|
||||||
* 08/06/2014
|
|
||||||
* Amend README.
|
|
||||||
|
|
||||||
#### 1.4.0
|
|
||||||
|
|
||||||
* 08/05/2014
|
|
||||||
* Add `toNumber`.
|
|
||||||
|
|
||||||
#### 1.3.0
|
|
||||||
|
|
||||||
* 08/11/2013
|
|
||||||
* Ensure correct rounding of `sqrt` in all, rather than almost all, cases.
|
|
||||||
* Maximum radix to 64.
|
|
||||||
|
|
||||||
#### 1.2.1
|
|
||||||
|
|
||||||
* 17/10/2013
|
|
||||||
* Sign of zero when x < 0 and x + (-x) = 0.
|
|
||||||
|
|
||||||
#### 1.2.0
|
|
||||||
|
|
||||||
* 19/9/2013
|
|
||||||
* Throw Error objects for stack.
|
|
||||||
|
|
||||||
#### 1.1.1
|
|
||||||
|
|
||||||
* 22/8/2013
|
|
||||||
* Show original value in constructor error message.
|
|
||||||
|
|
||||||
#### 1.1.0
|
|
||||||
|
|
||||||
* 1/8/2013
|
|
||||||
* Allow numbers with trailing radix point.
|
|
||||||
|
|
||||||
#### 1.0.1
|
|
||||||
|
|
||||||
* Bugfix: error messages with incorrect method name
|
|
||||||
|
|
||||||
#### 1.0.0
|
|
||||||
|
|
||||||
* 8/11/2012
|
|
||||||
* Initial release
|
|
||||||
-26
@@ -1,26 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
=====================
|
|
||||||
|
|
||||||
Copyright © `<2025>` `Michael Mclaughlin`
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person
|
|
||||||
obtaining a copy of this software and associated documentation
|
|
||||||
files (the “Software”), to deal in the Software without
|
|
||||||
restriction, including without limitation the rights to use,
|
|
||||||
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the
|
|
||||||
Software is furnished to do so, subject to the following
|
|
||||||
conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
||||||
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
||||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
||||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
||||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
||||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
||||||
OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
-289
@@ -1,289 +0,0 @@
|
|||||||
|
|
||||||
|
|
||||||
A JavaScript library for arbitrary-precision decimal and non-decimal arithmetic.
|
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/bignumber.js)
|
|
||||||
[](https://www.npmjs.com/package/bignumber.js)
|
|
||||||
[](https://github.com/MikeMcl/bignumber.js/actions/workflows/ci.yml)
|
|
||||||
|
|
||||||
<br />
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Integers and decimals
|
|
||||||
- Simple API but full-featured
|
|
||||||
- Faster, smaller, and perhaps easier to use than JavaScript versions of Java's BigDecimal
|
|
||||||
- 8 KB minified and gzipped
|
|
||||||
- Replicates the `toExponential`, `toFixed`, `toPrecision` and `toString` methods of JavaScript's Number type
|
|
||||||
- Includes a `toFraction` and a correctly-rounded `squareRoot` method
|
|
||||||
- Supports cryptographically-secure pseudo-random number generation
|
|
||||||
- No dependencies
|
|
||||||
- Wide platform compatibility: uses JavaScript 1.5 (ECMAScript 3) features only
|
|
||||||
- Comprehensive [documentation](http://mikemcl.github.io/bignumber.js/) and test set
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
If a smaller and simpler library is required see [big.js](https://github.com/MikeMcl/big.js/).
|
|
||||||
It's less than half the size but only works with decimal numbers and only has half the methods.
|
|
||||||
It also has fewer configuration options than this library, and does not allow `NaN` or `Infinity`.
|
|
||||||
|
|
||||||
See also [decimal.js](https://github.com/MikeMcl/decimal.js/), which among other things adds support for non-integer powers, and performs all operations to a specified number of significant digits.
|
|
||||||
|
|
||||||
## Load
|
|
||||||
|
|
||||||
The library is the single JavaScript file *bignumber.js* or ES module *bignumber.mjs*.
|
|
||||||
|
|
||||||
### Browser
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script src='path/to/bignumber.js'></script>
|
|
||||||
```
|
|
||||||
|
|
||||||
> ES module
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script type="module">
|
|
||||||
import BigNumber from './path/to/bignumber.mjs';
|
|
||||||
```
|
|
||||||
|
|
||||||
> Get a minified version from a CDN:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script src='https://cdn.jsdelivr.net/npm/bignumber.js@9.3.1/bignumber.min.js'></script>
|
|
||||||
```
|
|
||||||
|
|
||||||
### [Node.js](http://nodejs.org)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install bignumber.js
|
|
||||||
```
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const BigNumber = require('bignumber.js');
|
|
||||||
```
|
|
||||||
|
|
||||||
> ES module
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import BigNumber from "bignumber.js";
|
|
||||||
```
|
|
||||||
|
|
||||||
### [Deno](https://deno.land/)
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
// @deno-types="https://raw.githubusercontent.com/mikemcl/bignumber.js/v9.3.1/bignumber.d.mts"
|
|
||||||
import BigNumber from 'https://raw.githubusercontent.com/mikemcl/bignumber.js/v9.3.1/bignumber.mjs';
|
|
||||||
|
|
||||||
// @deno-types="https://unpkg.com/bignumber.js@latest/bignumber.d.mts"
|
|
||||||
import { BigNumber } from 'https://unpkg.com/bignumber.js@latest/bignumber.mjs';
|
|
||||||
```
|
|
||||||
|
|
||||||
## Use
|
|
||||||
|
|
||||||
The library exports a single constructor function, [`BigNumber`](http://mikemcl.github.io/bignumber.js/#bignumber), which accepts a value of type Number, String or BigNumber,
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
let x = new BigNumber(123.4567);
|
|
||||||
let y = BigNumber('123456.7e-3');
|
|
||||||
let z = new BigNumber(x);
|
|
||||||
x.isEqualTo(y) && y.isEqualTo(z) && x.isEqualTo(z); // true
|
|
||||||
```
|
|
||||||
|
|
||||||
To get the string value of a BigNumber use [`toString()`](http://mikemcl.github.io/bignumber.js/#toS) or [`toFixed()`](http://mikemcl.github.io/bignumber.js/#toFix). Using `toFixed()` prevents exponential notation being returned, no matter how large or small the value.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
let x = new BigNumber('1111222233334444555566');
|
|
||||||
x.toString(); // "1.111222233334444555566e+21"
|
|
||||||
x.toFixed(); // "1111222233334444555566"
|
|
||||||
```
|
|
||||||
|
|
||||||
If the limited precision of Number values is not well understood, it is recommended to create BigNumbers from String values rather than Number values to avoid a potential loss of precision.
|
|
||||||
|
|
||||||
*In all further examples below, `let`, semicolons and `toString` calls are not shown. If a commented-out value is in quotes it means `toString` has been called on the preceding expression.*
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
// Precision loss from using numeric literals with more than 15 significant digits.
|
|
||||||
new BigNumber(1.0000000000000001) // '1'
|
|
||||||
new BigNumber(88259496234518.57) // '88259496234518.56'
|
|
||||||
new BigNumber(99999999999999999999) // '100000000000000000000'
|
|
||||||
|
|
||||||
// Precision loss from using numeric literals outside the range of Number values.
|
|
||||||
new BigNumber(2e+308) // 'Infinity'
|
|
||||||
new BigNumber(1e-324) // '0'
|
|
||||||
|
|
||||||
// Precision loss from the unexpected result of arithmetic with Number values.
|
|
||||||
new BigNumber(0.7 + 0.1) // '0.7999999999999999'
|
|
||||||
```
|
|
||||||
|
|
||||||
When creating a BigNumber from a Number, note that a BigNumber is created from a Number's decimal `toString()` value not from its underlying binary value. If the latter is required, then pass the Number's `toString(2)` value and specify base 2.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
new BigNumber(Number.MAX_VALUE.toString(2), 2)
|
|
||||||
```
|
|
||||||
|
|
||||||
BigNumbers can be created from values in bases from 2 to 36. See [`ALPHABET`](http://mikemcl.github.io/bignumber.js/#alphabet) to extend this range.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
a = new BigNumber(1011, 2) // "11"
|
|
||||||
b = new BigNumber('zz.9', 36) // "1295.25"
|
|
||||||
c = a.plus(b) // "1306.25"
|
|
||||||
```
|
|
||||||
|
|
||||||
*Performance is better if base 10 is NOT specified for decimal values. Only specify base 10 when you want to limit the number of decimal places of the input value to the current [`DECIMAL_PLACES`](http://mikemcl.github.io/bignumber.js/#decimal-places) setting.*
|
|
||||||
|
|
||||||
A BigNumber is immutable in the sense that it is not changed by its methods.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
0.3 - 0.1 // 0.19999999999999998
|
|
||||||
x = new BigNumber(0.3)
|
|
||||||
x.minus(0.1) // "0.2"
|
|
||||||
x // "0.3"
|
|
||||||
```
|
|
||||||
|
|
||||||
The methods that return a BigNumber can be chained.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
x.dividedBy(y).plus(z).times(9)
|
|
||||||
x.times('1.23456780123456789e+9').plus(9876.5432321).dividedBy('4444562598.111772').integerValue()
|
|
||||||
```
|
|
||||||
|
|
||||||
Some of the longer method names have a shorter alias.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
x.squareRoot().dividedBy(y).exponentiatedBy(3).isEqualTo(x.sqrt().div(y).pow(3)) // true
|
|
||||||
x.modulo(y).multipliedBy(z).eq(x.mod(y).times(z)) // true
|
|
||||||
```
|
|
||||||
|
|
||||||
As with JavaScript's Number type, there are [`toExponential`](http://mikemcl.github.io/bignumber.js/#toE), [`toFixed`](http://mikemcl.github.io/bignumber.js/#toFix) and [`toPrecision`](http://mikemcl.github.io/bignumber.js/#toP) methods.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
x = new BigNumber(255.5)
|
|
||||||
x.toExponential(5) // "2.55500e+2"
|
|
||||||
x.toFixed(5) // "255.50000"
|
|
||||||
x.toPrecision(5) // "255.50"
|
|
||||||
x.toNumber() // 255.5
|
|
||||||
```
|
|
||||||
|
|
||||||
A base can be specified for [`toString`](http://mikemcl.github.io/bignumber.js/#toS).
|
|
||||||
|
|
||||||
*Performance is better if base 10 is NOT specified, i.e. use `toString()` not `toString(10)`. Only specify base 10 when you want to limit the number of decimal places of the string to the current [`DECIMAL_PLACES`](http://mikemcl.github.io/bignumber.js/#decimal-places) setting.*
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
x.toString(16) // "ff.8"
|
|
||||||
```
|
|
||||||
|
|
||||||
There is a [`toFormat`](http://mikemcl.github.io/bignumber.js/#toFor) method which may be useful for internationalisation.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
y = new BigNumber('1234567.898765')
|
|
||||||
y.toFormat(2) // "1,234,567.90"
|
|
||||||
```
|
|
||||||
|
|
||||||
The maximum number of decimal places of the result of an operation involving division (i.e. a division, square root, base conversion or negative power operation) is set using the `set` or `config` method of the `BigNumber` constructor.
|
|
||||||
|
|
||||||
The other arithmetic operations always give the exact result.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
BigNumber.set({ DECIMAL_PLACES: 10, ROUNDING_MODE: 4 })
|
|
||||||
|
|
||||||
x = new BigNumber(2)
|
|
||||||
y = new BigNumber(3)
|
|
||||||
z = x.dividedBy(y) // "0.6666666667"
|
|
||||||
z.squareRoot() // "0.8164965809"
|
|
||||||
z.exponentiatedBy(-3) // "3.3749999995"
|
|
||||||
z.toString(2) // "0.1010101011"
|
|
||||||
z.multipliedBy(z) // "0.44444444448888888889"
|
|
||||||
z.multipliedBy(z).decimalPlaces(10) // "0.4444444445"
|
|
||||||
```
|
|
||||||
|
|
||||||
There is a [`toFraction`](http://mikemcl.github.io/bignumber.js/#toFr) method with an optional *maximum denominator* argument
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
y = new BigNumber(355)
|
|
||||||
pi = y.dividedBy(113) // "3.1415929204"
|
|
||||||
pi.toFraction() // [ "7853982301", "2500000000" ]
|
|
||||||
pi.toFraction(1000) // [ "355", "113" ]
|
|
||||||
```
|
|
||||||
|
|
||||||
and [`isNaN`](http://mikemcl.github.io/bignumber.js/#isNaN) and [`isFinite`](http://mikemcl.github.io/bignumber.js/#isF) methods, as `NaN` and `Infinity` are valid `BigNumber` values.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
x = new BigNumber(NaN) // "NaN"
|
|
||||||
y = new BigNumber(Infinity) // "Infinity"
|
|
||||||
x.isNaN() && !y.isNaN() && !x.isFinite() && !y.isFinite() // true
|
|
||||||
```
|
|
||||||
|
|
||||||
The value of a BigNumber is stored in a decimal floating point format in terms of a coefficient, exponent and sign.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
x = new BigNumber(-123.456);
|
|
||||||
x.c // [ 123, 45600000000000 ] coefficient (i.e. significand)
|
|
||||||
x.e // 2 exponent
|
|
||||||
x.s // -1 sign
|
|
||||||
```
|
|
||||||
|
|
||||||
For advanced usage, multiple BigNumber constructors can be created, each with its own independent configuration.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
// Set DECIMAL_PLACES for the original BigNumber constructor
|
|
||||||
BigNumber.set({ DECIMAL_PLACES: 10 })
|
|
||||||
|
|
||||||
// Create another BigNumber constructor, optionally passing in a configuration object
|
|
||||||
BN = BigNumber.clone({ DECIMAL_PLACES: 5 })
|
|
||||||
|
|
||||||
x = new BigNumber(1)
|
|
||||||
y = new BN(1)
|
|
||||||
|
|
||||||
x.div(3) // '0.3333333333'
|
|
||||||
y.div(3) // '0.33333'
|
|
||||||
```
|
|
||||||
|
|
||||||
To avoid having to call `toString` or `valueOf` on a BigNumber to get its value in the Node.js REPL or when using `console.log` use
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
BigNumber.prototype[require('util').inspect.custom] = BigNumber.prototype.valueOf;
|
|
||||||
```
|
|
||||||
|
|
||||||
For further information see the [API](http://mikemcl.github.io/bignumber.js/) reference in the *doc* directory.
|
|
||||||
|
|
||||||
## Test
|
|
||||||
|
|
||||||
The *test/modules* directory contains the test scripts for each method.
|
|
||||||
|
|
||||||
The tests can be run with Node.js or a browser. For Node.js use
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm test
|
|
||||||
```
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
```bash
|
|
||||||
node test/test
|
|
||||||
```
|
|
||||||
|
|
||||||
To test a single method, use, for example
|
|
||||||
|
|
||||||
```bash
|
|
||||||
node test/methods/toFraction
|
|
||||||
```
|
|
||||||
|
|
||||||
For the browser, open *test/test.html*.
|
|
||||||
|
|
||||||
## Minify
|
|
||||||
|
|
||||||
To minify using, for example, [terser](https://github.com/terser/terser)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install -g terser
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash
|
|
||||||
terser big.js -c -m -o big.min.js
|
|
||||||
```
|
|
||||||
|
|
||||||
## Licence
|
|
||||||
|
|
||||||
The MIT Licence.
|
|
||||||
|
|
||||||
See [LICENCE](https://github.com/MikeMcl/bignumber.js/blob/main/LICENCE.md).
|
|
||||||
-6
@@ -1,6 +0,0 @@
|
|||||||
/// <reference path="./types.d.ts" />
|
|
||||||
|
|
||||||
export default BigNumber;
|
|
||||||
|
|
||||||
declare const BigNumberType: typeof BigNumber;
|
|
||||||
export { BigNumberType as BigNumber };
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
/// <reference path="./types.d.ts" />
|
|
||||||
|
|
||||||
export = BigNumber;
|
|
||||||
|
|
||||||
export as namespace BigNumber;
|
|
||||||
-2922
File diff suppressed because it is too large
Load Diff
-2907
File diff suppressed because it is too large
Load Diff
-2249
File diff suppressed because it is too large
Load Diff
-60
@@ -1,60 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "bignumber.js",
|
|
||||||
"description": "A library for arbitrary-precision decimal and non-decimal arithmetic",
|
|
||||||
"version": "9.3.1",
|
|
||||||
"keywords": [
|
|
||||||
"arbitrary",
|
|
||||||
"precision",
|
|
||||||
"arithmetic",
|
|
||||||
"big",
|
|
||||||
"number",
|
|
||||||
"decimal",
|
|
||||||
"float",
|
|
||||||
"biginteger",
|
|
||||||
"bigdecimal",
|
|
||||||
"bignumber",
|
|
||||||
"bigint",
|
|
||||||
"bignum"
|
|
||||||
],
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/MikeMcl/bignumber.js.git"
|
|
||||||
},
|
|
||||||
"main": "bignumber",
|
|
||||||
"module": "bignumber.mjs",
|
|
||||||
"browser": "bignumber.js",
|
|
||||||
"types": "bignumber.d.ts",
|
|
||||||
"exports": {
|
|
||||||
".": {
|
|
||||||
"import": {
|
|
||||||
"types": "./bignumber.d.mts",
|
|
||||||
"default": "./bignumber.mjs"
|
|
||||||
},
|
|
||||||
"require": {
|
|
||||||
"types": "./bignumber.d.ts",
|
|
||||||
"default": "./bignumber.js"
|
|
||||||
},
|
|
||||||
"browser": {
|
|
||||||
"types": "./bignumber.d.ts",
|
|
||||||
"default": "./bignumber.js"
|
|
||||||
},
|
|
||||||
"default": {
|
|
||||||
"types": "./bignumber.d.ts",
|
|
||||||
"default": "./bignumber.js"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"./package.json": "./package.json"
|
|
||||||
},
|
|
||||||
"author": {
|
|
||||||
"name": "Michael Mclaughlin",
|
|
||||||
"email": "M8ch88l@gmail.com"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": "*"
|
|
||||||
},
|
|
||||||
"license": "MIT",
|
|
||||||
"scripts": {
|
|
||||||
"test": "node test/test"
|
|
||||||
},
|
|
||||||
"dependencies": {}
|
|
||||||
}
|
|
||||||
-1821
File diff suppressed because it is too large
Load Diff
-23
@@ -1,23 +0,0 @@
|
|||||||
(The MIT License)
|
|
||||||
|
|
||||||
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
|
||||||
Copyright (c) 2014-2015 Douglas Christopher Wilson <doug@somethingdoug.com>
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
'Software'), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
||||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
||||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
||||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
||||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
-509
@@ -1,509 +0,0 @@
|
|||||||
# body-parser
|
|
||||||
|
|
||||||
[![NPM Version][npm-version-image]][npm-url]
|
|
||||||
[![NPM Downloads][npm-downloads-image]][npm-url]
|
|
||||||
[![Build Status][ci-image]][ci-url]
|
|
||||||
[![Test Coverage][coveralls-image]][coveralls-url]
|
|
||||||
[![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
|
|
||||||
|
|
||||||
Node.js body parsing middleware.
|
|
||||||
|
|
||||||
Parse incoming request bodies in a middleware before your handlers, available
|
|
||||||
under the `req.body` property.
|
|
||||||
|
|
||||||
**Note** As `req.body`'s shape is based on user-controlled input, all
|
|
||||||
properties and values in this object are untrusted and should be validated
|
|
||||||
before trusting. For example, `req.body.foo.toString()` may fail in multiple
|
|
||||||
ways, for example the `foo` property may not be there or may not be a string,
|
|
||||||
and `toString` may not be a function and instead a string or other user input.
|
|
||||||
|
|
||||||
[Learn about the anatomy of an HTTP transaction in Node.js](https://nodejs.org/en/learn/http/anatomy-of-an-http-transaction).
|
|
||||||
|
|
||||||
_This does not handle multipart bodies_, due to their complex and typically
|
|
||||||
large nature. For multipart bodies, you may be interested in the following
|
|
||||||
modules:
|
|
||||||
|
|
||||||
* [busboy](https://www.npmjs.com/package/busboy#readme) and
|
|
||||||
[connect-busboy](https://www.npmjs.com/package/connect-busboy#readme)
|
|
||||||
* [multiparty](https://www.npmjs.com/package/multiparty#readme) and
|
|
||||||
[connect-multiparty](https://www.npmjs.com/package/connect-multiparty#readme)
|
|
||||||
* [formidable](https://www.npmjs.com/package/formidable#readme)
|
|
||||||
* [multer](https://www.npmjs.com/package/multer#readme)
|
|
||||||
|
|
||||||
This module provides the following parsers:
|
|
||||||
|
|
||||||
* [JSON body parser](#bodyparserjsonoptions)
|
|
||||||
* [Raw body parser](#bodyparserrawoptions)
|
|
||||||
* [Text body parser](#bodyparsertextoptions)
|
|
||||||
* [URL-encoded form body parser](#bodyparserurlencodedoptions)
|
|
||||||
|
|
||||||
Other body parsers you might be interested in:
|
|
||||||
|
|
||||||
- [body](https://www.npmjs.com/package/body#readme)
|
|
||||||
- [co-body](https://www.npmjs.com/package/co-body#readme)
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ npm install body-parser
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
```js
|
|
||||||
// Import all parsers
|
|
||||||
const bodyParser = require('body-parser')
|
|
||||||
|
|
||||||
// Or import individual parsers directly
|
|
||||||
const json = require('body-parser/json')
|
|
||||||
const urlencoded = require('body-parser/urlencoded')
|
|
||||||
const raw = require('body-parser/raw')
|
|
||||||
const text = require('body-parser/text')
|
|
||||||
```
|
|
||||||
|
|
||||||
The `bodyParser` object exposes various factories to create middlewares. All
|
|
||||||
middlewares will populate the `req.body` property with the parsed body when
|
|
||||||
the `Content-Type` request header matches the `type` option.
|
|
||||||
|
|
||||||
The various errors returned by this module are described in the
|
|
||||||
[errors section](#errors).
|
|
||||||
|
|
||||||
### bodyParser.json([options])
|
|
||||||
|
|
||||||
Returns middleware that only parses `json` and only looks at requests where
|
|
||||||
the `Content-Type` header matches the `type` option. This parser accepts any
|
|
||||||
Unicode encoding of the body and supports automatic inflation of `gzip`,
|
|
||||||
`br` (brotli) and `deflate` encodings.
|
|
||||||
|
|
||||||
A new `body` object containing the parsed data is populated on the `request`
|
|
||||||
object after the middleware (i.e. `req.body`).
|
|
||||||
|
|
||||||
#### Options
|
|
||||||
|
|
||||||
The `json` function takes an optional `options` object that may contain any of
|
|
||||||
the following keys:
|
|
||||||
|
|
||||||
##### defaultCharset
|
|
||||||
|
|
||||||
Specify the default character set for the json content if the charset is not
|
|
||||||
specified in the `Content-Type` header of the request. Defaults to `utf-8`.
|
|
||||||
|
|
||||||
##### inflate
|
|
||||||
|
|
||||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
|
||||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
|
||||||
|
|
||||||
##### limit
|
|
||||||
|
|
||||||
Controls the maximum request body size. If this is a number, then the value
|
|
||||||
specifies the number of bytes; if it is a string, the value is passed to the
|
|
||||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
|
||||||
to `'100kb'`.
|
|
||||||
|
|
||||||
> It’s recommended not to configure a very high limit and to use the default value whenever possible. Allowing larger payloads increases memory usage because of the resources required for decoding and transformations, and it can also lead to longer response times as more data is processed. By ‘very high’, we mean values above the default, for example payloads of 5 MB or more can already start to introduce these risks. With the default limits, these issues do not occur.
|
|
||||||
|
|
||||||
##### reviver
|
|
||||||
|
|
||||||
The `reviver` option is passed directly to `JSON.parse` as the second
|
|
||||||
argument. You can find more information on this argument
|
|
||||||
[in the MDN documentation about JSON.parse](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#the_reviver_parameter).
|
|
||||||
|
|
||||||
##### strict
|
|
||||||
|
|
||||||
When set to `true`, will only accept arrays and objects; when `false` will
|
|
||||||
accept anything `JSON.parse` accepts. Defaults to `true`.
|
|
||||||
|
|
||||||
##### type
|
|
||||||
|
|
||||||
The `type` option is used to determine what media type the middleware will
|
|
||||||
parse. This option can be a string, array of strings, or a function. If not a
|
|
||||||
function, `type` option is passed directly to the
|
|
||||||
[type-is](https://www.npmjs.com/package/type-is#readme) library and this can
|
|
||||||
be an extension name (like `json`), a mime type (like `application/json`), or
|
|
||||||
a mime type with a wildcard (like `*/*` or `*/json`). If a function, the `type`
|
|
||||||
option is called as `fn(req)` and the request is parsed if it returns a truthy
|
|
||||||
value. Defaults to `application/json`.
|
|
||||||
|
|
||||||
##### verify
|
|
||||||
|
|
||||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
|
||||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
|
||||||
encoding of the request. The parsing can be aborted by throwing an error.
|
|
||||||
|
|
||||||
### bodyParser.raw([options])
|
|
||||||
|
|
||||||
Returns middleware that parses all bodies as a `Buffer` and only looks at
|
|
||||||
requests where the `Content-Type` header matches the `type` option. This
|
|
||||||
parser supports automatic inflation of `gzip`, `br` (brotli) and `deflate`
|
|
||||||
encodings.
|
|
||||||
|
|
||||||
A new `body` object containing the parsed data is populated on the `request`
|
|
||||||
object after the middleware (i.e. `req.body`). This will be a `Buffer` object
|
|
||||||
of the body.
|
|
||||||
|
|
||||||
#### Options
|
|
||||||
|
|
||||||
The `raw` function takes an optional `options` object that may contain any of
|
|
||||||
the following keys:
|
|
||||||
|
|
||||||
##### inflate
|
|
||||||
|
|
||||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
|
||||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
|
||||||
|
|
||||||
##### limit
|
|
||||||
|
|
||||||
Controls the maximum request body size. If this is a number, then the value
|
|
||||||
specifies the number of bytes; if it is a string, the value is passed to the
|
|
||||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
|
||||||
to `'100kb'`.
|
|
||||||
|
|
||||||
> It’s recommended not to configure a very high limit and to use the default value whenever possible. Allowing larger payloads increases memory usage because of the resources required for decoding and transformations, and it can also lead to longer response times as more data is processed. By ‘very high’, we mean values above the default, for example payloads of 5 MB or more can already start to introduce these risks. With the default limits, these issues do not occur.
|
|
||||||
|
|
||||||
##### type
|
|
||||||
|
|
||||||
The `type` option is used to determine what media type the middleware will
|
|
||||||
parse. This option can be a string, array of strings, or a function.
|
|
||||||
If not a function, `type` option is passed directly to the
|
|
||||||
[type-is](https://www.npmjs.com/package/type-is#readme) library and this
|
|
||||||
can be an extension name (like `bin`), a mime type (like
|
|
||||||
`application/octet-stream`), or a mime type with a wildcard (like `*/*` or
|
|
||||||
`application/*`). If a function, the `type` option is called as `fn(req)`
|
|
||||||
and the request is parsed if it returns a truthy value. Defaults to
|
|
||||||
`application/octet-stream`.
|
|
||||||
|
|
||||||
##### verify
|
|
||||||
|
|
||||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
|
||||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
|
||||||
encoding of the request. The parsing can be aborted by throwing an error.
|
|
||||||
|
|
||||||
### bodyParser.text([options])
|
|
||||||
|
|
||||||
Returns middleware that parses all bodies as a string and only looks at
|
|
||||||
requests where the `Content-Type` header matches the `type` option. This
|
|
||||||
parser supports automatic inflation of `gzip`, `br` (brotli) and `deflate`
|
|
||||||
encodings.
|
|
||||||
|
|
||||||
A new `body` string containing the parsed data is populated on the `request`
|
|
||||||
object after the middleware (i.e. `req.body`). This will be a string of the
|
|
||||||
body.
|
|
||||||
|
|
||||||
#### Options
|
|
||||||
|
|
||||||
The `text` function takes an optional `options` object that may contain any of
|
|
||||||
the following keys:
|
|
||||||
|
|
||||||
##### defaultCharset
|
|
||||||
|
|
||||||
Specify the default character set for the text content if the charset is not
|
|
||||||
specified in the `Content-Type` header of the request. Defaults to `utf-8`.
|
|
||||||
|
|
||||||
##### inflate
|
|
||||||
|
|
||||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
|
||||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
|
||||||
|
|
||||||
##### limit
|
|
||||||
|
|
||||||
Controls the maximum request body size. If this is a number, then the value
|
|
||||||
specifies the number of bytes; if it is a string, the value is passed to the
|
|
||||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
|
||||||
to `'100kb'`.
|
|
||||||
|
|
||||||
> It’s recommended not to configure a very high limit and to use the default value whenever possible. Allowing larger payloads increases memory usage because of the resources required for decoding and transformations, and it can also lead to longer response times as more data is processed. By ‘very high’, we mean values above the default, for example payloads of 5 MB or more can already start to introduce these risks. With the default limits, these issues do not occur.
|
|
||||||
|
|
||||||
##### type
|
|
||||||
|
|
||||||
The `type` option is used to determine what media type the middleware will
|
|
||||||
parse. This option can be a string, array of strings, or a function. If not
|
|
||||||
a function, `type` option is passed directly to the
|
|
||||||
[type-is](https://www.npmjs.com/package/type-is#readme) library and this can
|
|
||||||
be an extension name (like `txt`), a mime type (like `text/plain`), or a mime
|
|
||||||
type with a wildcard (like `*/*` or `text/*`). If a function, the `type`
|
|
||||||
option is called as `fn(req)` and the request is parsed if it returns a
|
|
||||||
truthy value. Defaults to `text/plain`.
|
|
||||||
|
|
||||||
##### verify
|
|
||||||
|
|
||||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
|
||||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
|
||||||
encoding of the request. The parsing can be aborted by throwing an error.
|
|
||||||
|
|
||||||
### bodyParser.urlencoded([options])
|
|
||||||
|
|
||||||
Returns middleware that only parses `urlencoded` bodies and only looks at
|
|
||||||
requests where the `Content-Type` header matches the `type` option. This
|
|
||||||
parser accepts only UTF-8 and ISO-8859-1 encodings of the body and supports
|
|
||||||
automatic inflation of `gzip`, `br` (brotli) and `deflate` encodings.
|
|
||||||
|
|
||||||
A new `body` object containing the parsed data is populated on the `request`
|
|
||||||
object after the middleware (i.e. `req.body`). This object will contain
|
|
||||||
key-value pairs, where the value can be a string or array (when `extended` is
|
|
||||||
`false`), or any type (when `extended` is `true`).
|
|
||||||
|
|
||||||
#### Options
|
|
||||||
|
|
||||||
The `urlencoded` function takes an optional `options` object that may contain
|
|
||||||
any of the following keys:
|
|
||||||
|
|
||||||
##### extended
|
|
||||||
|
|
||||||
The "extended" syntax allows for rich objects and arrays to be encoded into the
|
|
||||||
URL-encoded format, allowing for a JSON-like experience with URL-encoded. For
|
|
||||||
more information, please [see the qs
|
|
||||||
library](https://www.npmjs.com/package/qs#readme).
|
|
||||||
|
|
||||||
Defaults to `false`.
|
|
||||||
|
|
||||||
##### inflate
|
|
||||||
|
|
||||||
When set to `true`, then deflated (compressed) bodies will be inflated; when
|
|
||||||
`false`, deflated bodies are rejected. Defaults to `true`.
|
|
||||||
|
|
||||||
##### limit
|
|
||||||
|
|
||||||
Controls the maximum request body size. If this is a number, then the value
|
|
||||||
specifies the number of bytes; if it is a string, the value is passed to the
|
|
||||||
[bytes](https://www.npmjs.com/package/bytes) library for parsing. Defaults
|
|
||||||
to `'100kb'`.
|
|
||||||
|
|
||||||
> It’s recommended not to configure a very high limit and to use the default value whenever possible. Allowing larger payloads increases memory usage because of the resources required for decoding and transformations, and it can also lead to longer response times as more data is processed. By ‘very high’, we mean values above the default, for example payloads of 5 MB or more can already start to introduce these risks. With the default limits, these issues do not occur.
|
|
||||||
|
|
||||||
##### parameterLimit
|
|
||||||
|
|
||||||
The `parameterLimit` option controls the maximum number of parameters that
|
|
||||||
are allowed in the URL-encoded data. If a request contains more parameters
|
|
||||||
than this value, a 413 will be returned to the client. Defaults to `1000`.
|
|
||||||
|
|
||||||
##### type
|
|
||||||
|
|
||||||
The `type` option is used to determine what media type the middleware will
|
|
||||||
parse. This option can be a string, array of strings, or a function. If not
|
|
||||||
a function, `type` option is passed directly to the
|
|
||||||
[type-is](https://www.npmjs.com/package/type-is#readme) library and this can
|
|
||||||
be an extension name (like `urlencoded`), a mime type (like
|
|
||||||
`application/x-www-form-urlencoded`), or a mime type with a wildcard (like
|
|
||||||
`*/x-www-form-urlencoded`). If a function, the `type` option is called as
|
|
||||||
`fn(req)` and the request is parsed if it returns a truthy value. Defaults
|
|
||||||
to `application/x-www-form-urlencoded`.
|
|
||||||
|
|
||||||
##### verify
|
|
||||||
|
|
||||||
The `verify` option, if supplied, is called as `verify(req, res, buf, encoding)`,
|
|
||||||
where `buf` is a `Buffer` of the raw request body and `encoding` is the
|
|
||||||
encoding of the request. The parsing can be aborted by throwing an error.
|
|
||||||
|
|
||||||
##### defaultCharset
|
|
||||||
|
|
||||||
The default charset to parse as, if not specified in content-type. Must be
|
|
||||||
either `utf-8` or `iso-8859-1`. Defaults to `utf-8`.
|
|
||||||
|
|
||||||
##### charsetSentinel
|
|
||||||
|
|
||||||
Whether to let the value of the `utf8` parameter take precedence as the charset
|
|
||||||
selector. It requires the form to contain a parameter named `utf8` with a value
|
|
||||||
of `✓`. Defaults to `false`.
|
|
||||||
|
|
||||||
##### interpretNumericEntities
|
|
||||||
|
|
||||||
Whether to decode numeric entities such as `☺` when parsing an iso-8859-1
|
|
||||||
form. Defaults to `false`.
|
|
||||||
|
|
||||||
|
|
||||||
##### depth
|
|
||||||
|
|
||||||
The `depth` option is used to configure the maximum depth of the `qs` library when `extended` is `true`. This allows you to limit the amount of keys that are parsed and can be useful to prevent certain types of abuse. Defaults to `32`. It is recommended to keep this value as low as possible.
|
|
||||||
|
|
||||||
## Errors
|
|
||||||
|
|
||||||
The middlewares provided by this module create errors using the
|
|
||||||
[`http-errors` module](https://www.npmjs.com/package/http-errors). The errors
|
|
||||||
will typically have a `status`/`statusCode` property that contains the suggested
|
|
||||||
HTTP response code, an `expose` property to determine if the `message` property
|
|
||||||
should be displayed to the client, a `type` property to determine the type of
|
|
||||||
error without matching against the `message`, and a `body` property containing
|
|
||||||
the read body, if available.
|
|
||||||
|
|
||||||
The following are the common errors created, though any error can come through
|
|
||||||
for various reasons.
|
|
||||||
|
|
||||||
### content encoding unsupported
|
|
||||||
|
|
||||||
This error will occur when the request had a `Content-Encoding` header that
|
|
||||||
contained an encoding but the "inflation" option was set to `false`. The
|
|
||||||
`status` property is set to `415`, the `type` property is set to
|
|
||||||
`'encoding.unsupported'`, and the `charset` property will be set to the
|
|
||||||
encoding that is unsupported.
|
|
||||||
|
|
||||||
### entity parse failed
|
|
||||||
|
|
||||||
This error will occur when the request contained an entity that could not be
|
|
||||||
parsed by the middleware. The `status` property is set to `400`, the `type`
|
|
||||||
property is set to `'entity.parse.failed'`, and the `body` property is set to
|
|
||||||
the entity value that failed parsing.
|
|
||||||
|
|
||||||
### entity verify failed
|
|
||||||
|
|
||||||
This error will occur when the request contained an entity that could not be
|
|
||||||
failed verification by the defined `verify` option. The `status` property is
|
|
||||||
set to `403`, the `type` property is set to `'entity.verify.failed'`, and the
|
|
||||||
`body` property is set to the entity value that failed verification.
|
|
||||||
|
|
||||||
### request aborted
|
|
||||||
|
|
||||||
This error will occur when the request is aborted by the client before reading
|
|
||||||
the body has finished. The `received` property will be set to the number of
|
|
||||||
bytes received before the request was aborted and the `expected` property is
|
|
||||||
set to the number of expected bytes. The `status` property is set to `400`
|
|
||||||
and `type` property is set to `'request.aborted'`.
|
|
||||||
|
|
||||||
### request entity too large
|
|
||||||
|
|
||||||
This error will occur when the request body's size is larger than the "limit"
|
|
||||||
option. The `limit` property will be set to the byte limit and the `length`
|
|
||||||
property will be set to the request body's length. The `status` property is
|
|
||||||
set to `413` and the `type` property is set to `'entity.too.large'`.
|
|
||||||
|
|
||||||
### request size did not match content length
|
|
||||||
|
|
||||||
This error will occur when the request's length did not match the length from
|
|
||||||
the `Content-Length` header. This typically occurs when the request is malformed,
|
|
||||||
typically when the `Content-Length` header was calculated based on characters
|
|
||||||
instead of bytes. The `status` property is set to `400` and the `type` property
|
|
||||||
is set to `'request.size.invalid'`.
|
|
||||||
|
|
||||||
### stream encoding should not be set
|
|
||||||
|
|
||||||
This error will occur when something called the `req.setEncoding` method prior
|
|
||||||
to this middleware. This module operates directly on bytes only and you cannot
|
|
||||||
call `req.setEncoding` when using this module. The `status` property is set to
|
|
||||||
`500` and the `type` property is set to `'stream.encoding.set'`.
|
|
||||||
|
|
||||||
### stream is not readable
|
|
||||||
|
|
||||||
This error will occur when the request is no longer readable when this middleware
|
|
||||||
attempts to read it. This typically means something other than a middleware from
|
|
||||||
this module read the request body already and the middleware was also configured to
|
|
||||||
read the same request. The `status` property is set to `500` and the `type`
|
|
||||||
property is set to `'stream.not.readable'`.
|
|
||||||
|
|
||||||
### too many parameters
|
|
||||||
|
|
||||||
This error will occur when the content of the request exceeds the configured
|
|
||||||
`parameterLimit` for the `urlencoded` parser. The `status` property is set to
|
|
||||||
`413` and the `type` property is set to `'parameters.too.many'`.
|
|
||||||
|
|
||||||
### unsupported charset "BOGUS"
|
|
||||||
|
|
||||||
This error will occur when the request had a charset parameter in the
|
|
||||||
`Content-Type` header, but the `iconv-lite` module does not support it OR the
|
|
||||||
parser does not support it. The charset is contained in the message as well
|
|
||||||
as in the `charset` property. The `status` property is set to `415`, the
|
|
||||||
`type` property is set to `'charset.unsupported'`, and the `charset` property
|
|
||||||
is set to the charset that is unsupported.
|
|
||||||
|
|
||||||
### unsupported content encoding "bogus"
|
|
||||||
|
|
||||||
This error will occur when the request had a `Content-Encoding` header that
|
|
||||||
contained an unsupported encoding. The encoding is contained in the message
|
|
||||||
as well as in the `encoding` property. The `status` property is set to `415`,
|
|
||||||
the `type` property is set to `'encoding.unsupported'`, and the `encoding`
|
|
||||||
property is set to the encoding that is unsupported.
|
|
||||||
|
|
||||||
### The input exceeded the depth
|
|
||||||
|
|
||||||
This error occurs when using `bodyParser.urlencoded` with the `extended` property set to `true` and the input exceeds the configured `depth` option. The `status` property is set to `400`. It is recommended to review the `depth` option and evaluate if it requires a higher value. When the `depth` option is set to `32` (default value), the error will not be thrown.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Express/Connect top-level generic
|
|
||||||
|
|
||||||
This example demonstrates adding a generic JSON and URL-encoded parser as a
|
|
||||||
top-level middleware, which will parse the bodies of all incoming requests.
|
|
||||||
This is the simplest setup.
|
|
||||||
|
|
||||||
```js
|
|
||||||
const express = require('express')
|
|
||||||
const bodyParser = require('body-parser')
|
|
||||||
|
|
||||||
const app = express()
|
|
||||||
|
|
||||||
// parse application/x-www-form-urlencoded
|
|
||||||
app.use(bodyParser.urlencoded())
|
|
||||||
|
|
||||||
// parse application/json
|
|
||||||
app.use(bodyParser.json())
|
|
||||||
|
|
||||||
app.use(function (req, res) {
|
|
||||||
res.setHeader('Content-Type', 'text/plain')
|
|
||||||
res.write('you posted:\n')
|
|
||||||
res.end(String(JSON.stringify(req.body, null, 2)))
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
### Express route-specific
|
|
||||||
|
|
||||||
This example demonstrates adding body parsers specifically to the routes that
|
|
||||||
need them. In general, this is the most recommended way to use body-parser with
|
|
||||||
Express.
|
|
||||||
|
|
||||||
```js
|
|
||||||
const express = require('express')
|
|
||||||
const bodyParser = require('body-parser')
|
|
||||||
|
|
||||||
const app = express()
|
|
||||||
|
|
||||||
// create application/json parser
|
|
||||||
const jsonParser = bodyParser.json()
|
|
||||||
|
|
||||||
// create application/x-www-form-urlencoded parser
|
|
||||||
const urlencodedParser = bodyParser.urlencoded()
|
|
||||||
|
|
||||||
// POST /login gets urlencoded bodies
|
|
||||||
app.post('/login', urlencodedParser, function (req, res) {
|
|
||||||
if (!req.body || !req.body.username) res.sendStatus(400)
|
|
||||||
res.send('welcome, ' + req.body.username)
|
|
||||||
})
|
|
||||||
|
|
||||||
// POST /api/users gets JSON bodies
|
|
||||||
app.post('/api/users', jsonParser, function (req, res) {
|
|
||||||
if (!req.body) res.sendStatus(400)
|
|
||||||
// create user in req.body
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
### Change accepted type for parsers
|
|
||||||
|
|
||||||
All the parsers accept a `type` option which allows you to change the
|
|
||||||
`Content-Type` that the middleware will parse.
|
|
||||||
|
|
||||||
```js
|
|
||||||
const express = require('express')
|
|
||||||
const bodyParser = require('body-parser')
|
|
||||||
|
|
||||||
const app = express()
|
|
||||||
|
|
||||||
// parse various different custom JSON types as JSON
|
|
||||||
app.use(bodyParser.json({ type: 'application/*+json' }))
|
|
||||||
|
|
||||||
// parse some custom thing into a Buffer
|
|
||||||
app.use(bodyParser.raw({ type: 'application/vnd.custom-type' }))
|
|
||||||
|
|
||||||
// parse an HTML body into a string
|
|
||||||
app.use(bodyParser.text({ type: 'text/html' }))
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[MIT](LICENSE)
|
|
||||||
|
|
||||||
[ci-image]: https://img.shields.io/github/actions/workflow/status/expressjs/body-parser/ci.yml?branch=master&label=ci
|
|
||||||
[ci-url]: https://github.com/expressjs/body-parser/actions/workflows/ci.yml
|
|
||||||
[coveralls-image]: https://img.shields.io/coverallsCoverage/github/expressjs/body-parser?branch=master
|
|
||||||
[coveralls-url]: https://coveralls.io/r/expressjs/body-parser?branch=master
|
|
||||||
[npm-downloads-image]: https://img.shields.io/npm/dm/body-parser
|
|
||||||
[npm-url]: https://npmjs.com/package/body-parser
|
|
||||||
[npm-version-image]: https://img.shields.io/npm/v/body-parser
|
|
||||||
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/body-parser/badge
|
|
||||||
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/body-parser
|
|
||||||
-55
@@ -1,55 +0,0 @@
|
|||||||
/*!
|
|
||||||
* body-parser
|
|
||||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @typedef {Object} Parsers
|
|
||||||
* @property {Function} json JSON parser
|
|
||||||
* @property {Function} raw Raw parser
|
|
||||||
* @property {Function} text Text parser
|
|
||||||
* @property {Function} urlencoded URL-encoded parser
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
* @type {Function & Parsers}
|
|
||||||
*/
|
|
||||||
exports = module.exports = bodyParser
|
|
||||||
|
|
||||||
/**
|
|
||||||
* JSON parser.
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
exports.json = require('./lib/types/json')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Raw parser.
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
exports.raw = require('./lib/types/raw')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Text parser.
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
exports.text = require('./lib/types/text')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* URL-encoded parser.
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
exports.urlencoded = require('./lib/types/urlencoded')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a middleware to parse json and urlencoded bodies.
|
|
||||||
*
|
|
||||||
* @deprecated
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
function bodyParser () {
|
|
||||||
throw new Error('The bodyParser() generic has been split into individual middleware to use instead.')
|
|
||||||
}
|
|
||||||
-247
@@ -1,247 +0,0 @@
|
|||||||
/*!
|
|
||||||
* body-parser
|
|
||||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
|
|
||||||
const createError = require('http-errors')
|
|
||||||
const getBody = require('raw-body')
|
|
||||||
const iconv = require('iconv-lite')
|
|
||||||
const onFinished = require('on-finished')
|
|
||||||
const zlib = require('node:zlib')
|
|
||||||
const hasBody = require('type-is').hasBody
|
|
||||||
const { getCharset } = require('./utils')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = read
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Read a request into a buffer and parse.
|
|
||||||
*
|
|
||||||
* @param {Object} req
|
|
||||||
* @param {Object} res
|
|
||||||
* @param {Function} next
|
|
||||||
* @param {Function} parse
|
|
||||||
* @param {Function} debug
|
|
||||||
* @param {Object} options
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function read (req, res, next, parse, debug, options) {
|
|
||||||
if (onFinished.isFinished(req)) {
|
|
||||||
debug('body already parsed')
|
|
||||||
next()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!('body' in req)) {
|
|
||||||
req.body = undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
// skip requests without bodies
|
|
||||||
if (!hasBody(req)) {
|
|
||||||
debug('skip empty body')
|
|
||||||
next()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
debug('content-type %j', req.headers['content-type'])
|
|
||||||
|
|
||||||
// determine if request should be parsed
|
|
||||||
if (!options.shouldParse(req)) {
|
|
||||||
debug('skip parsing')
|
|
||||||
next()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
let encoding = null
|
|
||||||
if (options?.skipCharset !== true) {
|
|
||||||
encoding = getCharset(req) || options.defaultCharset
|
|
||||||
|
|
||||||
// validate charset
|
|
||||||
if (!!options?.isValidCharset && !options.isValidCharset(encoding)) {
|
|
||||||
debug('invalid charset')
|
|
||||||
next(createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
|
|
||||||
charset: encoding,
|
|
||||||
type: 'charset.unsupported'
|
|
||||||
}))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let length
|
|
||||||
const opts = options
|
|
||||||
let stream
|
|
||||||
|
|
||||||
// read options
|
|
||||||
const verify = opts.verify
|
|
||||||
|
|
||||||
try {
|
|
||||||
// get the content stream
|
|
||||||
stream = contentstream(req, debug, opts.inflate)
|
|
||||||
length = stream.length
|
|
||||||
stream.length = undefined
|
|
||||||
} catch (err) {
|
|
||||||
return next(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// set raw-body options
|
|
||||||
opts.length = length
|
|
||||||
opts.encoding = verify
|
|
||||||
? null
|
|
||||||
: encoding
|
|
||||||
|
|
||||||
// assert charset is supported
|
|
||||||
if (opts.encoding === null && encoding !== null && !iconv.encodingExists(encoding)) {
|
|
||||||
return next(createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
|
|
||||||
charset: encoding.toLowerCase(),
|
|
||||||
type: 'charset.unsupported'
|
|
||||||
}))
|
|
||||||
}
|
|
||||||
|
|
||||||
// read body
|
|
||||||
debug('read body')
|
|
||||||
getBody(stream, opts, function (error, body) {
|
|
||||||
if (error) {
|
|
||||||
let _error
|
|
||||||
|
|
||||||
if (error.type === 'encoding.unsupported') {
|
|
||||||
// echo back charset
|
|
||||||
_error = createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
|
|
||||||
charset: encoding.toLowerCase(),
|
|
||||||
type: 'charset.unsupported'
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
// set status code on error
|
|
||||||
_error = createError(400, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// unpipe from stream and destroy
|
|
||||||
if (stream !== req) {
|
|
||||||
req.unpipe()
|
|
||||||
stream.destroy()
|
|
||||||
}
|
|
||||||
|
|
||||||
// read off entire request
|
|
||||||
dump(req, function onfinished () {
|
|
||||||
next(createError(400, _error))
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// verify
|
|
||||||
if (verify) {
|
|
||||||
try {
|
|
||||||
debug('verify body')
|
|
||||||
verify(req, res, body, encoding)
|
|
||||||
} catch (err) {
|
|
||||||
next(createError(403, err, {
|
|
||||||
body: body,
|
|
||||||
type: err.type || 'entity.verify.failed'
|
|
||||||
}))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// parse
|
|
||||||
let str = body
|
|
||||||
try {
|
|
||||||
debug('parse body')
|
|
||||||
str = typeof body !== 'string' && encoding !== null
|
|
||||||
? iconv.decode(body, encoding)
|
|
||||||
: body
|
|
||||||
req.body = parse(str, encoding)
|
|
||||||
} catch (err) {
|
|
||||||
next(createError(400, err, {
|
|
||||||
body: str,
|
|
||||||
type: err.type || 'entity.parse.failed'
|
|
||||||
}))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
next()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the content stream of the request.
|
|
||||||
*
|
|
||||||
* @param {Object} req
|
|
||||||
* @param {Function} debug
|
|
||||||
* @param {boolean} inflate
|
|
||||||
* @returns {Object}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function contentstream (req, debug, inflate) {
|
|
||||||
const encoding = (req.headers['content-encoding'] || 'identity').toLowerCase()
|
|
||||||
const length = req.headers['content-length']
|
|
||||||
|
|
||||||
debug('content-encoding "%s"', encoding)
|
|
||||||
|
|
||||||
if (inflate === false && encoding !== 'identity') {
|
|
||||||
throw createError(415, 'content encoding unsupported', {
|
|
||||||
encoding: encoding,
|
|
||||||
type: 'encoding.unsupported'
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
if (encoding === 'identity') {
|
|
||||||
req.length = length
|
|
||||||
return req
|
|
||||||
}
|
|
||||||
|
|
||||||
const stream = createDecompressionStream(encoding, debug)
|
|
||||||
req.pipe(stream)
|
|
||||||
return stream
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a decompression stream for the given encoding.
|
|
||||||
* @param {string} encoding
|
|
||||||
* @param {Function} debug
|
|
||||||
* @returns {Object}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function createDecompressionStream (encoding, debug) {
|
|
||||||
switch (encoding) {
|
|
||||||
case 'deflate':
|
|
||||||
debug('inflate body')
|
|
||||||
return zlib.createInflate()
|
|
||||||
case 'gzip':
|
|
||||||
debug('gunzip body')
|
|
||||||
return zlib.createGunzip()
|
|
||||||
case 'br':
|
|
||||||
debug('brotli decompress body')
|
|
||||||
return zlib.createBrotliDecompress()
|
|
||||||
default:
|
|
||||||
throw createError(415, 'unsupported content encoding "' + encoding + '"', {
|
|
||||||
encoding: encoding,
|
|
||||||
type: 'encoding.unsupported'
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Dump the contents of a request.
|
|
||||||
*
|
|
||||||
* @param {Object} req
|
|
||||||
* @param {Function} callback
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function dump (req, callback) {
|
|
||||||
if (onFinished.isFinished(req)) {
|
|
||||||
callback(null)
|
|
||||||
} else {
|
|
||||||
onFinished(req, callback)
|
|
||||||
req.resume()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-186
@@ -1,186 +0,0 @@
|
|||||||
/*!
|
|
||||||
* body-parser
|
|
||||||
* Copyright(c) 2014 Jonathan Ong
|
|
||||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
|
|
||||||
const debug = require('debug')('body-parser:json')
|
|
||||||
const read = require('../read')
|
|
||||||
const { normalizeOptions } = require('../utils')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = json
|
|
||||||
|
|
||||||
/**
|
|
||||||
* RegExp to match the first non-space in a string.
|
|
||||||
*
|
|
||||||
* Allowed whitespace is defined in RFC 7159:
|
|
||||||
*
|
|
||||||
* ws = *(
|
|
||||||
* %x20 / ; Space
|
|
||||||
* %x09 / ; Horizontal tab
|
|
||||||
* %x0A / ; Line feed or New line
|
|
||||||
* %x0D ) ; Carriage return
|
|
||||||
*/
|
|
||||||
const FIRST_CHAR_REGEXP = /^[\x20\x09\x0a\x0d]*([^\x20\x09\x0a\x0d])/ // eslint-disable-line no-control-regex
|
|
||||||
|
|
||||||
const JSON_SYNTAX_CHAR = '#'
|
|
||||||
const JSON_SYNTAX_REGEXP = /#+/g
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a middleware to parse JSON bodies.
|
|
||||||
*
|
|
||||||
* @param {Object} [options]
|
|
||||||
* @returns {Function}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
function json (options) {
|
|
||||||
const normalizedOptions = normalizeOptions(options, 'application/json')
|
|
||||||
|
|
||||||
const parse = createJsonParser(options)
|
|
||||||
|
|
||||||
const readOptions = {
|
|
||||||
...normalizedOptions,
|
|
||||||
// assert charset per RFC 7159 sec 8.1
|
|
||||||
isValidCharset: (charset) => charset.slice(0, 4) === 'utf-'
|
|
||||||
}
|
|
||||||
|
|
||||||
return function jsonParser (req, res, next) {
|
|
||||||
read(req, res, next, parse, debug, readOptions)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a JSON parse function
|
|
||||||
*
|
|
||||||
* @param {object} [options]
|
|
||||||
* @return {function}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function createJsonParser (options) {
|
|
||||||
const reviver = options?.reviver
|
|
||||||
const strict = options?.strict !== false
|
|
||||||
|
|
||||||
if (strict) {
|
|
||||||
return function parse (body) {
|
|
||||||
if (body.length === 0) {
|
|
||||||
// special-case empty json body, as it's a common client-side mistake
|
|
||||||
// TODO: maybe make this configurable or part of "strict" option
|
|
||||||
return {}
|
|
||||||
}
|
|
||||||
|
|
||||||
const first = firstchar(body)
|
|
||||||
if (first !== '{' && first !== '[') {
|
|
||||||
debug('strict violation')
|
|
||||||
throw createStrictSyntaxError(body, first)
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
debug('parse json')
|
|
||||||
return JSON.parse(body, reviver)
|
|
||||||
} catch (e) {
|
|
||||||
throw normalizeJsonSyntaxError(e, {
|
|
||||||
message: e.message,
|
|
||||||
stack: e.stack
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return function parse (body) {
|
|
||||||
if (body.length === 0) {
|
|
||||||
// special-case empty json body, as it's a common client-side mistake
|
|
||||||
// TODO: maybe make this configurable or part of "strict" option
|
|
||||||
return {}
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
debug('parse json')
|
|
||||||
return JSON.parse(body, reviver)
|
|
||||||
} catch (e) {
|
|
||||||
throw normalizeJsonSyntaxError(e, {
|
|
||||||
message: e.message,
|
|
||||||
stack: e.stack
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create strict violation syntax error matching native error.
|
|
||||||
*
|
|
||||||
* @param {string} str
|
|
||||||
* @param {string} char
|
|
||||||
* @returns {Error}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function createStrictSyntaxError (str, char) {
|
|
||||||
const index = str.indexOf(char)
|
|
||||||
let partial = ''
|
|
||||||
|
|
||||||
if (index !== -1) {
|
|
||||||
partial = str.substring(0, index) + JSON_SYNTAX_CHAR.repeat(str.length - index)
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
JSON.parse(partial); /* istanbul ignore next */ throw new SyntaxError('strict violation')
|
|
||||||
} catch (e) {
|
|
||||||
return normalizeJsonSyntaxError(e, {
|
|
||||||
message: e.message.replace(JSON_SYNTAX_REGEXP, function (placeholder) {
|
|
||||||
return str.substring(index, index + placeholder.length)
|
|
||||||
}),
|
|
||||||
stack: e.stack
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the first non-whitespace character in a string.
|
|
||||||
*
|
|
||||||
* @param {string} str
|
|
||||||
* @returns {string|undefined}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function firstchar (str) {
|
|
||||||
const match = FIRST_CHAR_REGEXP.exec(str)
|
|
||||||
|
|
||||||
return match
|
|
||||||
? match[1]
|
|
||||||
: undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Normalize a SyntaxError for JSON.parse.
|
|
||||||
*
|
|
||||||
* @param {SyntaxError} error
|
|
||||||
* @param {Object} obj
|
|
||||||
* @returns {SyntaxError}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function normalizeJsonSyntaxError (error, obj) {
|
|
||||||
const keys = Object.getOwnPropertyNames(error)
|
|
||||||
|
|
||||||
for (let i = 0; i < keys.length; i++) {
|
|
||||||
const key = keys[i]
|
|
||||||
if (key !== 'stack' && key !== 'message') {
|
|
||||||
delete error[key]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// replace stack before message for Node.js 0.10 and below
|
|
||||||
error.stack = obj.stack.replace(error.message, obj.message)
|
|
||||||
error.message = obj.message
|
|
||||||
|
|
||||||
return error
|
|
||||||
}
|
|
||||||
-42
@@ -1,42 +0,0 @@
|
|||||||
/*!
|
|
||||||
* body-parser
|
|
||||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const debug = require('debug')('body-parser:raw')
|
|
||||||
const read = require('../read')
|
|
||||||
const { normalizeOptions, passthrough } = require('../utils')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = raw
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a middleware to parse raw bodies.
|
|
||||||
*
|
|
||||||
* @param {Object} [options]
|
|
||||||
* @returns {Function}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
function raw (options) {
|
|
||||||
const normalizedOptions = normalizeOptions(options, 'application/octet-stream')
|
|
||||||
|
|
||||||
const readOptions = {
|
|
||||||
...normalizedOptions,
|
|
||||||
// Skip charset validation and parse the body as is
|
|
||||||
skipCharset: true
|
|
||||||
}
|
|
||||||
|
|
||||||
return function rawParser (req, res, next) {
|
|
||||||
read(req, res, next, passthrough, debug, readOptions)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-36
@@ -1,36 +0,0 @@
|
|||||||
/*!
|
|
||||||
* body-parser
|
|
||||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const debug = require('debug')('body-parser:text')
|
|
||||||
const read = require('../read')
|
|
||||||
const { normalizeOptions, passthrough } = require('../utils')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = text
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a middleware to parse text bodies.
|
|
||||||
*
|
|
||||||
* @param {Object} [options]
|
|
||||||
* @returns {Function}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
function text (options) {
|
|
||||||
const normalizedOptions = normalizeOptions(options, 'text/plain')
|
|
||||||
|
|
||||||
return function textParser (req, res, next) {
|
|
||||||
read(req, res, next, passthrough, debug, normalizedOptions)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-138
@@ -1,138 +0,0 @@
|
|||||||
/*!
|
|
||||||
* body-parser
|
|
||||||
* Copyright(c) 2014 Jonathan Ong
|
|
||||||
* Copyright(c) 2014-2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
|
|
||||||
const createError = require('http-errors')
|
|
||||||
const debug = require('debug')('body-parser:urlencoded')
|
|
||||||
const read = require('../read')
|
|
||||||
const qs = require('qs')
|
|
||||||
const { normalizeOptions } = require('../utils')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = urlencoded
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a middleware to parse urlencoded bodies.
|
|
||||||
*
|
|
||||||
* @param {Object} [options]
|
|
||||||
* @returns {Function}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
function urlencoded (options) {
|
|
||||||
const normalizedOptions = normalizeOptions(options, 'application/x-www-form-urlencoded')
|
|
||||||
|
|
||||||
if (normalizedOptions.defaultCharset !== 'utf-8' && normalizedOptions.defaultCharset !== 'iso-8859-1') {
|
|
||||||
throw new TypeError('option defaultCharset must be either utf-8 or iso-8859-1')
|
|
||||||
}
|
|
||||||
|
|
||||||
// create the appropriate query parser
|
|
||||||
const parse = createQueryParser(options)
|
|
||||||
|
|
||||||
const readOptions = {
|
|
||||||
...normalizedOptions,
|
|
||||||
// assert charset
|
|
||||||
isValidCharset: (charset) => charset === 'utf-8' || charset === 'iso-8859-1'
|
|
||||||
}
|
|
||||||
|
|
||||||
return function urlencodedParser (req, res, next) {
|
|
||||||
read(req, res, next, parse, debug, readOptions)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the extended query parser.
|
|
||||||
*
|
|
||||||
* @param {Object} options
|
|
||||||
* @returns {Function}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function createQueryParser (options) {
|
|
||||||
const extended = Boolean(options?.extended)
|
|
||||||
let parameterLimit = options?.parameterLimit !== undefined
|
|
||||||
? options?.parameterLimit
|
|
||||||
: 1000
|
|
||||||
const charsetSentinel = options?.charsetSentinel
|
|
||||||
const interpretNumericEntities = options?.interpretNumericEntities
|
|
||||||
const depth = extended ? (options?.depth !== undefined ? options?.depth : 32) : 0
|
|
||||||
|
|
||||||
if (isNaN(parameterLimit) || parameterLimit < 1) {
|
|
||||||
throw new TypeError('option parameterLimit must be a positive number')
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isNaN(depth) || depth < 0) {
|
|
||||||
throw new TypeError('option depth must be a zero or a positive number')
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isFinite(parameterLimit)) {
|
|
||||||
parameterLimit = parameterLimit | 0
|
|
||||||
}
|
|
||||||
|
|
||||||
return function parse (body, encoding) {
|
|
||||||
if (!body.length) return {}
|
|
||||||
|
|
||||||
const paramCount = parameterCount(body, parameterLimit)
|
|
||||||
|
|
||||||
if (paramCount === undefined) {
|
|
||||||
debug('too many parameters')
|
|
||||||
throw createError(413, 'too many parameters', {
|
|
||||||
type: 'parameters.too.many'
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
const arrayLimit = extended ? Math.max(100, paramCount) : paramCount
|
|
||||||
|
|
||||||
debug('parse ' + (extended ? 'extended ' : '') + 'urlencoding')
|
|
||||||
try {
|
|
||||||
return qs.parse(body, {
|
|
||||||
allowPrototypes: true,
|
|
||||||
arrayLimit: arrayLimit,
|
|
||||||
depth: depth,
|
|
||||||
charsetSentinel: charsetSentinel,
|
|
||||||
interpretNumericEntities: interpretNumericEntities,
|
|
||||||
charset: encoding,
|
|
||||||
parameterLimit: parameterLimit,
|
|
||||||
strictDepth: true
|
|
||||||
})
|
|
||||||
} catch (err) {
|
|
||||||
if (err instanceof RangeError) {
|
|
||||||
throw createError(400, 'The input exceeded the depth', {
|
|
||||||
type: 'querystring.parse.rangeError'
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
throw err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Count the number of parameters, stopping once limit reached
|
|
||||||
*
|
|
||||||
* @param {string} body
|
|
||||||
* @param {number} limit
|
|
||||||
* @returns {number|undefined} Returns undefined if limit exceeded
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function parameterCount (body, limit) {
|
|
||||||
let count = 0
|
|
||||||
let index = -1
|
|
||||||
do {
|
|
||||||
count++
|
|
||||||
if (count > limit) return undefined // Early exit if limit exceeded
|
|
||||||
index = body.indexOf('&', index + 1)
|
|
||||||
} while (index !== -1)
|
|
||||||
return count
|
|
||||||
}
|
|
||||||
-100
@@ -1,100 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module dependencies.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const bytes = require('bytes')
|
|
||||||
const contentType = require('content-type')
|
|
||||||
const typeis = require('type-is')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
*/
|
|
||||||
module.exports = {
|
|
||||||
getCharset,
|
|
||||||
normalizeOptions,
|
|
||||||
passthrough
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the charset of a request.
|
|
||||||
*
|
|
||||||
* @param {Object} req
|
|
||||||
* @returns {string | undefined}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function getCharset (req) {
|
|
||||||
const header = req.headers['content-type']
|
|
||||||
if (!header) return undefined
|
|
||||||
return contentType.parse(header).parameters.charset?.toLowerCase()
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the simple type checker.
|
|
||||||
*
|
|
||||||
* @param {string | string[]} type
|
|
||||||
* @returns {Function}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function typeChecker (type) {
|
|
||||||
return function checkType (req) {
|
|
||||||
return Boolean(typeis(req, type))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Normalizes the common options for all parsers.
|
|
||||||
*
|
|
||||||
* @param {Object} options options to normalize
|
|
||||||
* @param {string | string[] | Function} defaultType default content type(s) or a function to determine it
|
|
||||||
* @returns {Object}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function normalizeOptions (options, defaultType) {
|
|
||||||
if (!defaultType) {
|
|
||||||
// Parsers must define a default content type
|
|
||||||
throw new TypeError('defaultType must be provided')
|
|
||||||
}
|
|
||||||
|
|
||||||
const inflate = options?.inflate !== false
|
|
||||||
const limit = typeof options?.limit === 'undefined' || options?.limit === null
|
|
||||||
? 102400 // 100kb default
|
|
||||||
: bytes.parse(options.limit)
|
|
||||||
const type = options?.type || defaultType
|
|
||||||
const verify = options?.verify || false
|
|
||||||
const defaultCharset = options?.defaultCharset || 'utf-8'
|
|
||||||
|
|
||||||
if (limit === null) {
|
|
||||||
throw new TypeError(`option limit "${String(options.limit)}" is invalid`)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (verify !== false && typeof verify !== 'function') {
|
|
||||||
throw new TypeError('option verify must be function')
|
|
||||||
}
|
|
||||||
|
|
||||||
// create the appropriate type checking function
|
|
||||||
const shouldParse = typeof type !== 'function'
|
|
||||||
? typeChecker(type)
|
|
||||||
: type
|
|
||||||
|
|
||||||
return {
|
|
||||||
inflate,
|
|
||||||
limit,
|
|
||||||
verify,
|
|
||||||
defaultCharset,
|
|
||||||
shouldParse
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Passthrough function that returns input unchanged.
|
|
||||||
* Used by parsers that don't need to transform the data.
|
|
||||||
*
|
|
||||||
* @param {*} value
|
|
||||||
* @returns {*}
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
function passthrough (value) {
|
|
||||||
return value
|
|
||||||
}
|
|
||||||
-22
@@ -1,22 +0,0 @@
|
|||||||
(The MIT License)
|
|
||||||
|
|
||||||
Copyright (c) 2015 Douglas Christopher Wilson
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
'Software'), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
||||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
||||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
||||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
||||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
-69
@@ -1,69 +0,0 @@
|
|||||||
# content-type
|
|
||||||
|
|
||||||
[![NPM version][npm-image]][npm-url]
|
|
||||||
[![NPM downloads][downloads-image]][downloads-url]
|
|
||||||
[![Build status][build-image]][build-url]
|
|
||||||
[![Build coverage][coverage-image]][coverage-url]
|
|
||||||
[![License][license-image]][license-url]
|
|
||||||
|
|
||||||
Create and parse HTTP `Content-Type` header.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install content-type
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
```js
|
|
||||||
const contentType = require("content-type");
|
|
||||||
```
|
|
||||||
|
|
||||||
### contentType.parse(string, options?)
|
|
||||||
|
|
||||||
```js
|
|
||||||
const obj = contentType.parse("image/svg+xml; charset=utf-8");
|
|
||||||
```
|
|
||||||
|
|
||||||
Parse a `Content-Type` header. This will return an object with the following properties (examples are shown for the string `'image/svg+xml; charset=utf-8'`):
|
|
||||||
|
|
||||||
- `type`: The media type. Example: `'image/svg+xml'`.
|
|
||||||
- `parameters`: An object of the parameters in the media type (parameter name is always lower case). Example: `{charset: 'utf-8'}`.
|
|
||||||
|
|
||||||
The parser is lenient and does not error. You should validate `type` and `parameters` before trusting them.
|
|
||||||
|
|
||||||
#### Options
|
|
||||||
|
|
||||||
- `parameters` (default: `true`): Set to `false` to skip parameters.
|
|
||||||
|
|
||||||
### contentType.format(obj)
|
|
||||||
|
|
||||||
```js
|
|
||||||
const str = contentType.format({
|
|
||||||
type: "image/svg+xml",
|
|
||||||
parameters: { charset: "utf-8" },
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
Format an object into a `Content-Type` header. This will return a string of the content type for the given object with the following properties (examples are shown that produce the string `'image/svg+xml; charset=utf-8'`):
|
|
||||||
|
|
||||||
- `type`: The media type. Example: `'image/svg+xml'`.
|
|
||||||
- `parameters`: An optional object of the parameters in the media type. Example: `{charset: 'utf-8'}`.
|
|
||||||
|
|
||||||
Throws a `TypeError` if the object contains an invalid type or parameter names.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[MIT](LICENSE)
|
|
||||||
|
|
||||||
[npm-image]: https://img.shields.io/npm/v/content-type
|
|
||||||
[npm-url]: https://npmjs.org/package/content-type
|
|
||||||
[downloads-image]: https://img.shields.io/npm/dm/content-type
|
|
||||||
[downloads-url]: https://npmjs.org/package/content-type
|
|
||||||
[build-image]: https://img.shields.io/github/actions/workflow/status/jshttp/content-type/ci.yml?branch=master
|
|
||||||
[build-url]: https://github.com/jshttp/content-type/actions/workflows/ci.yml?query=branch%3Amaster
|
|
||||||
[coverage-image]: https://img.shields.io/codecov/c/gh/jshttp/content-type
|
|
||||||
[coverage-url]: https://codecov.io/gh/jshttp/content-type
|
|
||||||
[license-image]: http://img.shields.io/npm/l/content-type.svg?style=flat
|
|
||||||
[license-url]: LICENSE
|
|
||||||
-26
@@ -1,26 +0,0 @@
|
|||||||
/*!
|
|
||||||
* content-type
|
|
||||||
* Copyright(c) 2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* The content type object contains a type string and optional parameters.
|
|
||||||
*/
|
|
||||||
export interface ContentType {
|
|
||||||
type: string;
|
|
||||||
parameters: Record<string, string>;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Format an object into a `Content-Type` header.
|
|
||||||
*/
|
|
||||||
export declare function format(obj: Partial<ContentType>): string;
|
|
||||||
/**
|
|
||||||
* Options for parsing a `Content-Type` header.
|
|
||||||
*/
|
|
||||||
export interface ParseOptions {
|
|
||||||
parameters?: boolean;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Parse a `Content-Type` header.
|
|
||||||
*/
|
|
||||||
export declare function parse(header: string, options?: ParseOptions): ContentType;
|
|
||||||
-170
@@ -1,170 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
/*!
|
|
||||||
* content-type
|
|
||||||
* Copyright(c) 2015 Douglas Christopher Wilson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
exports.format = format;
|
|
||||||
exports.parse = parse;
|
|
||||||
const TEXT_REGEXP = /^[\u0009\u0020-\u007e\u0080-\u00ff]*$/;
|
|
||||||
const TOKEN_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/;
|
|
||||||
/**
|
|
||||||
* RegExp to match chars that must be quoted-pair in RFC 9110 sec 5.6.4
|
|
||||||
*/
|
|
||||||
const QUOTE_REGEXP = /[\\"]/g;
|
|
||||||
/**
|
|
||||||
* RegExp to match type in RFC 9110 sec 8.3.1
|
|
||||||
*
|
|
||||||
* media-type = type "/" subtype
|
|
||||||
* type = token
|
|
||||||
* subtype = token
|
|
||||||
*/
|
|
||||||
const TYPE_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/;
|
|
||||||
/**
|
|
||||||
* Null object perf optimization. Faster than `Object.create(null)` and `{ __proto__: null }`.
|
|
||||||
*/
|
|
||||||
const NullObject = /* @__PURE__ */ (() => {
|
|
||||||
const C = function () { };
|
|
||||||
C.prototype = Object.create(null);
|
|
||||||
return C;
|
|
||||||
})();
|
|
||||||
/**
|
|
||||||
* Format an object into a `Content-Type` header.
|
|
||||||
*/
|
|
||||||
function format(obj) {
|
|
||||||
const { type, parameters } = obj;
|
|
||||||
if (!type || !TYPE_REGEXP.test(type)) {
|
|
||||||
throw new TypeError(`Invalid type: ${type}`);
|
|
||||||
}
|
|
||||||
let result = type;
|
|
||||||
if (parameters) {
|
|
||||||
for (const param of Object.keys(parameters)) {
|
|
||||||
if (!TOKEN_REGEXP.test(param)) {
|
|
||||||
throw new TypeError(`Invalid parameter name: ${param}`);
|
|
||||||
}
|
|
||||||
result += `; ${param}=${qstring(parameters[param])}`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Parse a `Content-Type` header.
|
|
||||||
*/
|
|
||||||
function parse(header, options) {
|
|
||||||
const len = header.length;
|
|
||||||
let index = skipOWS(header, 0, len);
|
|
||||||
const valueStart = index;
|
|
||||||
index = skipValue(header, index, len);
|
|
||||||
const valueEnd = trailingOWS(header, valueStart, index);
|
|
||||||
const type = header.slice(valueStart, valueEnd).toLowerCase();
|
|
||||||
const parameters = options?.parameters === false
|
|
||||||
? new NullObject()
|
|
||||||
: parseParameters(header, index, len);
|
|
||||||
return { type, parameters };
|
|
||||||
}
|
|
||||||
const SP = 32; // " "
|
|
||||||
const HTAB = 9; // "\t"
|
|
||||||
const SEMI = 59; // ";"
|
|
||||||
const EQ = 61; // "="
|
|
||||||
const DQUOTE = 34; // '"'
|
|
||||||
const BSLASH = 92; // "\\"
|
|
||||||
/**
|
|
||||||
* Parses the parameters of a `Content-Type` header starting at the given index.
|
|
||||||
*/
|
|
||||||
function parseParameters(header, index, len) {
|
|
||||||
const parameters = new NullObject();
|
|
||||||
parameter: while (index < len) {
|
|
||||||
index = skipOWS(header, index + 1 /* Skip over ; */, len);
|
|
||||||
const keyStart = index;
|
|
||||||
while (index < len) {
|
|
||||||
const code = header.charCodeAt(index);
|
|
||||||
if (code === SEMI)
|
|
||||||
continue parameter;
|
|
||||||
if (code === EQ) {
|
|
||||||
const keyEnd = trailingOWS(header, keyStart, index);
|
|
||||||
const key = header.slice(keyStart, keyEnd).toLowerCase();
|
|
||||||
index = skipOWS(header, index + 1, len);
|
|
||||||
if (index < len && header.charCodeAt(index) === DQUOTE) {
|
|
||||||
index++;
|
|
||||||
let value = "";
|
|
||||||
while (index < len) {
|
|
||||||
const code = header.charCodeAt(index++);
|
|
||||||
if (code === DQUOTE) {
|
|
||||||
index = skipValue(header, index, len);
|
|
||||||
if (parameters[key] === undefined)
|
|
||||||
parameters[key] = value;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
if (code === BSLASH && index < len) {
|
|
||||||
value += header[index++];
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
value += String.fromCharCode(code);
|
|
||||||
}
|
|
||||||
continue parameter;
|
|
||||||
}
|
|
||||||
const valueStart = index;
|
|
||||||
index = skipValue(header, index, len);
|
|
||||||
if (parameters[key] === undefined) {
|
|
||||||
const valueEnd = trailingOWS(header, valueStart, index);
|
|
||||||
parameters[key] = header.slice(valueStart, valueEnd);
|
|
||||||
}
|
|
||||||
continue parameter;
|
|
||||||
}
|
|
||||||
index++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return parameters;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Skip over characters until a semicolon.
|
|
||||||
*/
|
|
||||||
function skipValue(str, index, len) {
|
|
||||||
while (index < len) {
|
|
||||||
const char = str.charCodeAt(index);
|
|
||||||
if (char === SEMI)
|
|
||||||
break;
|
|
||||||
index++;
|
|
||||||
}
|
|
||||||
return index;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Skip optional whitespace (OWS) in an HTTP header value.
|
|
||||||
*
|
|
||||||
* OWS is defined in RFC 9110 sec 5.6.3 as SP (" ") or HTAB ("\t").
|
|
||||||
*/
|
|
||||||
function skipOWS(header, index, len) {
|
|
||||||
while (index < len) {
|
|
||||||
const char = header.charCodeAt(index);
|
|
||||||
if (char !== SP && char !== HTAB)
|
|
||||||
break;
|
|
||||||
index++;
|
|
||||||
}
|
|
||||||
return index;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Trim optional whitespace (OWS) from the end of a substring.
|
|
||||||
*
|
|
||||||
* OWS is defined in RFC 9110 sec 5.6.3 as SP (" ") or HTAB ("\t").
|
|
||||||
*/
|
|
||||||
function trailingOWS(header, start, end) {
|
|
||||||
while (end > start) {
|
|
||||||
const char = header.charCodeAt(end - 1);
|
|
||||||
if (char !== SP && char !== HTAB)
|
|
||||||
break;
|
|
||||||
end--;
|
|
||||||
}
|
|
||||||
return end;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Serialize a parameter value.
|
|
||||||
*/
|
|
||||||
function qstring(str) {
|
|
||||||
if (TOKEN_REGEXP.test(str))
|
|
||||||
return str;
|
|
||||||
if (TEXT_REGEXP.test(str))
|
|
||||||
return `"${str.replace(QUOTE_REGEXP, "\\$&")}"`;
|
|
||||||
throw new TypeError(`Invalid parameter value: ${str}`);
|
|
||||||
}
|
|
||||||
//# sourceMappingURL=index.js.map
|
|
||||||
-1
File diff suppressed because one or more lines are too long
-52
@@ -1,52 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "content-type",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"description": "Create and parse HTTP Content-Type header",
|
|
||||||
"keywords": [
|
|
||||||
"content-type",
|
|
||||||
"http",
|
|
||||||
"req",
|
|
||||||
"res",
|
|
||||||
"rfc7231",
|
|
||||||
"rfc9110"
|
|
||||||
],
|
|
||||||
"repository": "jshttp/content-type",
|
|
||||||
"funding": {
|
|
||||||
"type": "opencollective",
|
|
||||||
"url": "https://opencollective.com/express"
|
|
||||||
},
|
|
||||||
"license": "MIT",
|
|
||||||
"author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
|
|
||||||
"type": "commonjs",
|
|
||||||
"exports": "./dist/index.js",
|
|
||||||
"main": "./dist/index.js",
|
|
||||||
"typings": "./dist/index.d.ts",
|
|
||||||
"files": [
|
|
||||||
"dist/"
|
|
||||||
],
|
|
||||||
"scripts": {
|
|
||||||
"bench": "vitest bench",
|
|
||||||
"build": "ts-scripts build",
|
|
||||||
"format": "ts-scripts format",
|
|
||||||
"prepare": "ts-scripts install && npm run build",
|
|
||||||
"specs": "ts-scripts specs",
|
|
||||||
"test": "ts-scripts test"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@borderless/ts-scripts": "^0.15.0",
|
|
||||||
"@vitest/coverage-v8": "^3.0.5",
|
|
||||||
"typescript": "^5.7.3",
|
|
||||||
"vitest": "^3.2.4"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=18"
|
|
||||||
},
|
|
||||||
"ts-scripts": {
|
|
||||||
"dist": [
|
|
||||||
"dist"
|
|
||||||
],
|
|
||||||
"project": [
|
|
||||||
"tsconfig.build.json"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-65
@@ -1,65 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "body-parser",
|
|
||||||
"description": "Node.js body parsing middleware",
|
|
||||||
"version": "2.3.0",
|
|
||||||
"contributors": [
|
|
||||||
"Douglas Christopher Wilson <doug@somethingdoug.com>",
|
|
||||||
"Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
|
|
||||||
],
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": "expressjs/body-parser",
|
|
||||||
"funding": {
|
|
||||||
"type": "opencollective",
|
|
||||||
"url": "https://opencollective.com/express"
|
|
||||||
},
|
|
||||||
"type": "commonjs",
|
|
||||||
"exports": {
|
|
||||||
".": "./index.js",
|
|
||||||
"./package.json": "./package.json",
|
|
||||||
"./json": "./lib/types/json.js",
|
|
||||||
"./raw": "./lib/types/raw.js",
|
|
||||||
"./text": "./lib/types/text.js",
|
|
||||||
"./urlencoded": "./lib/types/urlencoded.js",
|
|
||||||
"./lib/*": "./lib/*.js",
|
|
||||||
"./lib/*.js": "./lib/*.js",
|
|
||||||
"./lib/types/*": "./lib/types/*.js",
|
|
||||||
"./lib/types/*.js": "./lib/types/*.js"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"bytes": "^3.1.2",
|
|
||||||
"content-type": "^2.0.0",
|
|
||||||
"debug": "^4.4.3",
|
|
||||||
"http-errors": "^2.0.1",
|
|
||||||
"iconv-lite": "^0.7.2",
|
|
||||||
"on-finished": "^2.4.1",
|
|
||||||
"qs": "^6.15.2",
|
|
||||||
"raw-body": "^3.0.2",
|
|
||||||
"type-is": "^2.1.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"eslint": "^8.57.1",
|
|
||||||
"eslint-config-standard": "^14.1.1",
|
|
||||||
"eslint-plugin-import": "^2.32.0",
|
|
||||||
"eslint-plugin-markdown": "^3.0.1",
|
|
||||||
"eslint-plugin-node": "^11.1.0",
|
|
||||||
"eslint-plugin-promise": "^6.6.0",
|
|
||||||
"eslint-plugin-standard": "^4.1.0",
|
|
||||||
"mocha": "^11.7.6",
|
|
||||||
"nyc": "^17.1.0",
|
|
||||||
"supertest": "^7.2.2"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"lib/",
|
|
||||||
"LICENSE",
|
|
||||||
"index.js"
|
|
||||||
],
|
|
||||||
"engines": {
|
|
||||||
"node": ">=18"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"lint": "eslint .",
|
|
||||||
"test": "mocha --reporter spec --check-leaks test/",
|
|
||||||
"test-ci": "nyc --reporter=lcovonly --reporter=text npm test",
|
|
||||||
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-97
@@ -1,97 +0,0 @@
|
|||||||
3.1.2 / 2022-01-27
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Fix return value for un-parsable strings
|
|
||||||
|
|
||||||
3.1.1 / 2021-11-15
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Fix "thousandsSeparator" incorrecting formatting fractional part
|
|
||||||
|
|
||||||
3.1.0 / 2019-01-22
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Add petabyte (`pb`) support
|
|
||||||
|
|
||||||
3.0.0 / 2017-08-31
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Change "kB" to "KB" in format output
|
|
||||||
* Remove support for Node.js 0.6
|
|
||||||
* Remove support for ComponentJS
|
|
||||||
|
|
||||||
2.5.0 / 2017-03-24
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Add option "unit"
|
|
||||||
|
|
||||||
2.4.0 / 2016-06-01
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Add option "unitSeparator"
|
|
||||||
|
|
||||||
2.3.0 / 2016-02-15
|
|
||||||
==================
|
|
||||||
|
|
||||||
* Drop partial bytes on all parsed units
|
|
||||||
* Fix non-finite numbers to `.format` to return `null`
|
|
||||||
* Fix parsing byte string that looks like hex
|
|
||||||
* perf: hoist regular expressions
|
|
||||||
|
|
||||||
2.2.0 / 2015-11-13
|
|
||||||
==================
|
|
||||||
|
|
||||||
* add option "decimalPlaces"
|
|
||||||
* add option "fixedDecimals"
|
|
||||||
|
|
||||||
2.1.0 / 2015-05-21
|
|
||||||
==================
|
|
||||||
|
|
||||||
* add `.format` export
|
|
||||||
* add `.parse` export
|
|
||||||
|
|
||||||
2.0.2 / 2015-05-20
|
|
||||||
==================
|
|
||||||
|
|
||||||
* remove map recreation
|
|
||||||
* remove unnecessary object construction
|
|
||||||
|
|
||||||
2.0.1 / 2015-05-07
|
|
||||||
==================
|
|
||||||
|
|
||||||
* fix browserify require
|
|
||||||
* remove node.extend dependency
|
|
||||||
|
|
||||||
2.0.0 / 2015-04-12
|
|
||||||
==================
|
|
||||||
|
|
||||||
* add option "case"
|
|
||||||
* add option "thousandsSeparator"
|
|
||||||
* return "null" on invalid parse input
|
|
||||||
* support proper round-trip: bytes(bytes(num)) === num
|
|
||||||
* units no longer case sensitive when parsing
|
|
||||||
|
|
||||||
1.0.0 / 2014-05-05
|
|
||||||
==================
|
|
||||||
|
|
||||||
* add negative support. fixes #6
|
|
||||||
|
|
||||||
0.3.0 / 2014-03-19
|
|
||||||
==================
|
|
||||||
|
|
||||||
* added terabyte support
|
|
||||||
|
|
||||||
0.2.1 / 2013-04-01
|
|
||||||
==================
|
|
||||||
|
|
||||||
* add .component
|
|
||||||
|
|
||||||
0.2.0 / 2012-10-28
|
|
||||||
==================
|
|
||||||
|
|
||||||
* bytes(200).should.eql('200b')
|
|
||||||
|
|
||||||
0.1.0 / 2012-07-04
|
|
||||||
==================
|
|
||||||
|
|
||||||
* add bytes to string conversion [yields]
|
|
||||||
-23
@@ -1,23 +0,0 @@
|
|||||||
(The MIT License)
|
|
||||||
|
|
||||||
Copyright (c) 2012-2014 TJ Holowaychuk <tj@vision-media.ca>
|
|
||||||
Copyright (c) 2015 Jed Watson <jed.watson@me.com>
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
'Software'), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
||||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
||||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
||||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
||||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
-152
@@ -1,152 +0,0 @@
|
|||||||
# Bytes utility
|
|
||||||
|
|
||||||
[![NPM Version][npm-image]][npm-url]
|
|
||||||
[![NPM Downloads][downloads-image]][downloads-url]
|
|
||||||
[![Build Status][ci-image]][ci-url]
|
|
||||||
[![Test Coverage][coveralls-image]][coveralls-url]
|
|
||||||
|
|
||||||
Utility to parse a string bytes (ex: `1TB`) to bytes (`1099511627776`) and vice-versa.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
This is a [Node.js](https://nodejs.org/en/) module available through the
|
|
||||||
[npm registry](https://www.npmjs.com/). Installation is done using the
|
|
||||||
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ npm install bytes
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```js
|
|
||||||
var bytes = require('bytes');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### bytes(number｜string value, [options]): number｜string｜null
|
|
||||||
|
|
||||||
Default export function. Delegates to either `bytes.format` or `bytes.parse` based on the type of `value`.
|
|
||||||
|
|
||||||
**Arguments**
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|---------|----------|--------------------|
|
|
||||||
| value | `number`｜`string` | Number value to format or string value to parse |
|
|
||||||
| options | `Object` | Conversion options for `format` |
|
|
||||||
|
|
||||||
**Returns**
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|---------|------------------|-------------------------------------------------|
|
|
||||||
| results | `string`｜`number`｜`null` | Return null upon error. Numeric value in bytes, or string value otherwise. |
|
|
||||||
|
|
||||||
**Example**
|
|
||||||
|
|
||||||
```js
|
|
||||||
bytes(1024);
|
|
||||||
// output: '1KB'
|
|
||||||
|
|
||||||
bytes('1KB');
|
|
||||||
// output: 1024
|
|
||||||
```
|
|
||||||
|
|
||||||
#### bytes.format(number value, [options]): string｜null
|
|
||||||
|
|
||||||
Format the given value in bytes into a string. If the value is negative, it is kept as such. If it is a float, it is
|
|
||||||
rounded.
|
|
||||||
|
|
||||||
**Arguments**
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|---------|----------|--------------------|
|
|
||||||
| value | `number` | Value in bytes |
|
|
||||||
| options | `Object` | Conversion options |
|
|
||||||
|
|
||||||
**Options**
|
|
||||||
|
|
||||||
| Property | Type | Description |
|
|
||||||
|-------------------|--------|-----------------------------------------------------------------------------------------|
|
|
||||||
| decimalPlaces | `number`｜`null` | Maximum number of decimal places to include in output. Default value to `2`. |
|
|
||||||
| fixedDecimals | `boolean`｜`null` | Whether to always display the maximum number of decimal places. Default value to `false` |
|
|
||||||
| thousandsSeparator | `string`｜`null` | Example of values: `' '`, `','` and `'.'`... Default value to `''`. |
|
|
||||||
| unit | `string`｜`null` | The unit in which the result will be returned (B/KB/MB/GB/TB). Default value to `''` (which means auto detect). |
|
|
||||||
| unitSeparator | `string`｜`null` | Separator to use between number and unit. Default value to `''`. |
|
|
||||||
|
|
||||||
**Returns**
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|---------|------------------|-------------------------------------------------|
|
|
||||||
| results | `string`｜`null` | Return null upon error. String value otherwise. |
|
|
||||||
|
|
||||||
**Example**
|
|
||||||
|
|
||||||
```js
|
|
||||||
bytes.format(1024);
|
|
||||||
// output: '1KB'
|
|
||||||
|
|
||||||
bytes.format(1000);
|
|
||||||
// output: '1000B'
|
|
||||||
|
|
||||||
bytes.format(1000, {thousandsSeparator: ' '});
|
|
||||||
// output: '1 000B'
|
|
||||||
|
|
||||||
bytes.format(1024 * 1.7, {decimalPlaces: 0});
|
|
||||||
// output: '2KB'
|
|
||||||
|
|
||||||
bytes.format(1024, {unitSeparator: ' '});
|
|
||||||
// output: '1 KB'
|
|
||||||
```
|
|
||||||
|
|
||||||
#### bytes.parse(string｜number value): number｜null
|
|
||||||
|
|
||||||
Parse the string value into an integer in bytes. If no unit is given, or `value`
|
|
||||||
is a number, it is assumed the value is in bytes.
|
|
||||||
|
|
||||||
Supported units and abbreviations are as follows and are case-insensitive:
|
|
||||||
|
|
||||||
* `b` for bytes
|
|
||||||
* `kb` for kilobytes
|
|
||||||
* `mb` for megabytes
|
|
||||||
* `gb` for gigabytes
|
|
||||||
* `tb` for terabytes
|
|
||||||
* `pb` for petabytes
|
|
||||||
|
|
||||||
The units are in powers of two, not ten. This means 1kb = 1024b according to this parser.
|
|
||||||
|
|
||||||
**Arguments**
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|---------------|--------|--------------------|
|
|
||||||
| value | `string`｜`number` | String to parse, or number in bytes. |
|
|
||||||
|
|
||||||
**Returns**
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|---------|-------------|-------------------------|
|
|
||||||
| results | `number`｜`null` | Return null upon error. Value in bytes otherwise. |
|
|
||||||
|
|
||||||
**Example**
|
|
||||||
|
|
||||||
```js
|
|
||||||
bytes.parse('1KB');
|
|
||||||
// output: 1024
|
|
||||||
|
|
||||||
bytes.parse('1024');
|
|
||||||
// output: 1024
|
|
||||||
|
|
||||||
bytes.parse(1024);
|
|
||||||
// output: 1024
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[MIT](LICENSE)
|
|
||||||
|
|
||||||
[ci-image]: https://badgen.net/github/checks/visionmedia/bytes.js/master?label=ci
|
|
||||||
[ci-url]: https://github.com/visionmedia/bytes.js/actions?query=workflow%3Aci
|
|
||||||
[coveralls-image]: https://badgen.net/coveralls/c/github/visionmedia/bytes.js/master
|
|
||||||
[coveralls-url]: https://coveralls.io/r/visionmedia/bytes.js?branch=master
|
|
||||||
[downloads-image]: https://badgen.net/npm/dm/bytes
|
|
||||||
[downloads-url]: https://npmjs.org/package/bytes
|
|
||||||
[npm-image]: https://badgen.net/npm/v/bytes
|
|
||||||
[npm-url]: https://npmjs.org/package/bytes
|
|
||||||
-170
@@ -1,170 +0,0 @@
|
|||||||
/*!
|
|
||||||
* bytes
|
|
||||||
* Copyright(c) 2012-2014 TJ Holowaychuk
|
|
||||||
* Copyright(c) 2015 Jed Watson
|
|
||||||
* MIT Licensed
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module exports.
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
module.exports = bytes;
|
|
||||||
module.exports.format = format;
|
|
||||||
module.exports.parse = parse;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Module variables.
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
|
|
||||||
var formatThousandsRegExp = /\B(?=(\d{3})+(?!\d))/g;
|
|
||||||
|
|
||||||
var formatDecimalsRegExp = /(?:\.0*|(\.[^0]+)0+)$/;
|
|
||||||
|
|
||||||
var map = {
|
|
||||||
b: 1,
|
|
||||||
kb: 1 << 10,
|
|
||||||
mb: 1 << 20,
|
|
||||||
gb: 1 << 30,
|
|
||||||
tb: Math.pow(1024, 4),
|
|
||||||
pb: Math.pow(1024, 5),
|
|
||||||
};
|
|
||||||
|
|
||||||
var parseRegExp = /^((-|\+)?(\d+(?:\.\d+)?)) *(kb|mb|gb|tb|pb)$/i;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert the given value in bytes into a string or parse to string to an integer in bytes.
|
|
||||||
*
|
|
||||||
* @param {string|number} value
|
|
||||||
* @param {{
|
|
||||||
* case: [string],
|
|
||||||
* decimalPlaces: [number]
|
|
||||||
* fixedDecimals: [boolean]
|
|
||||||
* thousandsSeparator: [string]
|
|
||||||
* unitSeparator: [string]
|
|
||||||
* }} [options] bytes options.
|
|
||||||
*
|
|
||||||
* @returns {string|number|null}
|
|
||||||
*/
|
|
||||||
|
|
||||||
function bytes(value, options) {
|
|
||||||
if (typeof value === 'string') {
|
|
||||||
return parse(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof value === 'number') {
|
|
||||||
return format(value, options);
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Format the given value in bytes into a string.
|
|
||||||
*
|
|
||||||
* If the value is negative, it is kept as such. If it is a float,
|
|
||||||
* it is rounded.
|
|
||||||
*
|
|
||||||
* @param {number} value
|
|
||||||
* @param {object} [options]
|
|
||||||
* @param {number} [options.decimalPlaces=2]
|
|
||||||
* @param {number} [options.fixedDecimals=false]
|
|
||||||
* @param {string} [options.thousandsSeparator=]
|
|
||||||
* @param {string} [options.unit=]
|
|
||||||
* @param {string} [options.unitSeparator=]
|
|
||||||
*
|
|
||||||
* @returns {string|null}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
function format(value, options) {
|
|
||||||
if (!Number.isFinite(value)) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
var mag = Math.abs(value);
|
|
||||||
var thousandsSeparator = (options && options.thousandsSeparator) || '';
|
|
||||||
var unitSeparator = (options && options.unitSeparator) || '';
|
|
||||||
var decimalPlaces = (options && options.decimalPlaces !== undefined) ? options.decimalPlaces : 2;
|
|
||||||
var fixedDecimals = Boolean(options && options.fixedDecimals);
|
|
||||||
var unit = (options && options.unit) || '';
|
|
||||||
|
|
||||||
if (!unit || !map[unit.toLowerCase()]) {
|
|
||||||
if (mag >= map.pb) {
|
|
||||||
unit = 'PB';
|
|
||||||
} else if (mag >= map.tb) {
|
|
||||||
unit = 'TB';
|
|
||||||
} else if (mag >= map.gb) {
|
|
||||||
unit = 'GB';
|
|
||||||
} else if (mag >= map.mb) {
|
|
||||||
unit = 'MB';
|
|
||||||
} else if (mag >= map.kb) {
|
|
||||||
unit = 'KB';
|
|
||||||
} else {
|
|
||||||
unit = 'B';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var val = value / map[unit.toLowerCase()];
|
|
||||||
var str = val.toFixed(decimalPlaces);
|
|
||||||
|
|
||||||
if (!fixedDecimals) {
|
|
||||||
str = str.replace(formatDecimalsRegExp, '$1');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (thousandsSeparator) {
|
|
||||||
str = str.split('.').map(function (s, i) {
|
|
||||||
return i === 0
|
|
||||||
? s.replace(formatThousandsRegExp, thousandsSeparator)
|
|
||||||
: s
|
|
||||||
}).join('.');
|
|
||||||
}
|
|
||||||
|
|
||||||
return str + unitSeparator + unit;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parse the string value into an integer in bytes.
|
|
||||||
*
|
|
||||||
* If no unit is given, it is assumed the value is in bytes.
|
|
||||||
*
|
|
||||||
* @param {number|string} val
|
|
||||||
*
|
|
||||||
* @returns {number|null}
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
|
|
||||||
function parse(val) {
|
|
||||||
if (typeof val === 'number' && !isNaN(val)) {
|
|
||||||
return val;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof val !== 'string') {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test if the string passed is valid
|
|
||||||
var results = parseRegExp.exec(val);
|
|
||||||
var floatValue;
|
|
||||||
var unit = 'b';
|
|
||||||
|
|
||||||
if (!results) {
|
|
||||||
// Nothing could be extracted from the given string
|
|
||||||
floatValue = parseInt(val, 10);
|
|
||||||
unit = 'b'
|
|
||||||
} else {
|
|
||||||
// Retrieve the value and the unit
|
|
||||||
floatValue = parseFloat(results[1]);
|
|
||||||
unit = results[4].toLowerCase();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isNaN(floatValue)) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Math.floor(map[unit] * floatValue);
|
|
||||||
}
|
|
||||||
-42
@@ -1,42 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "bytes",
|
|
||||||
"description": "Utility to parse a string bytes to bytes and vice-versa",
|
|
||||||
"version": "3.1.2",
|
|
||||||
"author": "TJ Holowaychuk <tj@vision-media.ca> (http://tjholowaychuk.com)",
|
|
||||||
"contributors": [
|
|
||||||
"Jed Watson <jed.watson@me.com>",
|
|
||||||
"Théo FIDRY <theo.fidry@gmail.com>"
|
|
||||||
],
|
|
||||||
"license": "MIT",
|
|
||||||
"keywords": [
|
|
||||||
"byte",
|
|
||||||
"bytes",
|
|
||||||
"utility",
|
|
||||||
"parse",
|
|
||||||
"parser",
|
|
||||||
"convert",
|
|
||||||
"converter"
|
|
||||||
],
|
|
||||||
"repository": "visionmedia/bytes.js",
|
|
||||||
"devDependencies": {
|
|
||||||
"eslint": "7.32.0",
|
|
||||||
"eslint-plugin-markdown": "2.2.1",
|
|
||||||
"mocha": "9.2.0",
|
|
||||||
"nyc": "15.1.0"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"History.md",
|
|
||||||
"LICENSE",
|
|
||||||
"Readme.md",
|
|
||||||
"index.js"
|
|
||||||
],
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 0.8"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"lint": "eslint .",
|
|
||||||
"test": "mocha --check-leaks --reporter spec",
|
|
||||||
"test-ci": "nyc --reporter=lcov --reporter=text npm test",
|
|
||||||
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-17
@@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"root": true,
|
|
||||||
|
|
||||||
"extends": "@ljharb",
|
|
||||||
|
|
||||||
"rules": {
|
|
||||||
"func-name-matching": 0,
|
|
||||||
"id-length": 0,
|
|
||||||
"new-cap": [2, {
|
|
||||||
"capIsNewExceptions": [
|
|
||||||
"GetIntrinsic",
|
|
||||||
],
|
|
||||||
}],
|
|
||||||
"no-extra-parens": 0,
|
|
||||||
"no-magic-numbers": 0,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
-12
@@ -1,12 +0,0 @@
|
|||||||
# These are supported funding model platforms
|
|
||||||
|
|
||||||
github: [ljharb]
|
|
||||||
patreon: # Replace with a single Patreon username
|
|
||||||
open_collective: # Replace with a single Open Collective username
|
|
||||||
ko_fi: # Replace with a single Ko-fi username
|
|
||||||
tidelift: npm/call-bind-apply-helpers
|
|
||||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
|
||||||
liberapay: # Replace with a single Liberapay username
|
|
||||||
issuehunt: # Replace with a single IssueHunt username
|
|
||||||
otechie: # Replace with a single Otechie username
|
|
||||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
|
||||||
-9
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"all": true,
|
|
||||||
"check-coverage": false,
|
|
||||||
"reporter": ["text-summary", "text", "html", "json"],
|
|
||||||
"exclude": [
|
|
||||||
"coverage",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
-30
@@ -1,30 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
|
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
||||||
|
|
||||||
## [v1.0.2](https://github.com/ljharb/call-bind-apply-helpers/compare/v1.0.1...v1.0.2) - 2025-02-12
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
|
|
||||||
- [types] improve inferred types [`e6f9586`](https://github.com/ljharb/call-bind-apply-helpers/commit/e6f95860a3c72879cb861a858cdfb8138fbedec1)
|
|
||||||
- [Dev Deps] update `@arethetypeswrong/cli`, `@ljharb/tsconfig`, `@types/tape`, `es-value-fixtures`, `for-each`, `has-strict-mode`, `object-inspect` [`e43d540`](https://github.com/ljharb/call-bind-apply-helpers/commit/e43d5409f97543bfbb11f345d47d8ce4e066d8c1)
|
|
||||||
|
|
||||||
## [v1.0.1](https://github.com/ljharb/call-bind-apply-helpers/compare/v1.0.0...v1.0.1) - 2024-12-08
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
|
|
||||||
- [types] `reflectApply`: fix types [`4efc396`](https://github.com/ljharb/call-bind-apply-helpers/commit/4efc3965351a4f02cc55e836fa391d3d11ef2ef8)
|
|
||||||
- [Fix] `reflectApply`: oops, Reflect is not a function [`83cc739`](https://github.com/ljharb/call-bind-apply-helpers/commit/83cc7395de6b79b7730bdf092f1436f0b1263c75)
|
|
||||||
- [Dev Deps] update `@arethetypeswrong/cli` [`80bd5d3`](https://github.com/ljharb/call-bind-apply-helpers/commit/80bd5d3ae58b4f6b6995ce439dd5a1bcb178a940)
|
|
||||||
|
|
||||||
## v1.0.0 - 2024-12-05
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
|
|
||||||
- Initial implementation, tests, readme [`7879629`](https://github.com/ljharb/call-bind-apply-helpers/commit/78796290f9b7430c9934d6f33d94ae9bc89fce04)
|
|
||||||
- Initial commit [`3f1dc16`](https://github.com/ljharb/call-bind-apply-helpers/commit/3f1dc164afc43285631b114a5f9dd9137b2b952f)
|
|
||||||
- npm init [`081df04`](https://github.com/ljharb/call-bind-apply-helpers/commit/081df048c312fcee400922026f6e97281200a603)
|
|
||||||
- Only apps should have lockfiles [`5b9ca0f`](https://github.com/ljharb/call-bind-apply-helpers/commit/5b9ca0fe8101ebfaf309c549caac4e0a017ed930)
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2024 Jordan Harband
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
-62
@@ -1,62 +0,0 @@
|
|||||||
# call-bind-apply-helpers <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
|
||||||
|
|
||||||
[![github actions][actions-image]][actions-url]
|
|
||||||
[![coverage][codecov-image]][codecov-url]
|
|
||||||
[![dependency status][deps-svg]][deps-url]
|
|
||||||
[![dev dependency status][dev-deps-svg]][dev-deps-url]
|
|
||||||
[![License][license-image]][license-url]
|
|
||||||
[![Downloads][downloads-image]][downloads-url]
|
|
||||||
|
|
||||||
[![npm badge][npm-badge-png]][package-url]
|
|
||||||
|
|
||||||
Helper functions around Function call/apply/bind, for use in `call-bind`.
|
|
||||||
|
|
||||||
The only packages that should likely ever use this package directly are `call-bind` and `get-intrinsic`.
|
|
||||||
Please use `call-bind` unless you have a very good reason not to.
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install --save call-bind-apply-helpers
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage/Examples
|
|
||||||
|
|
||||||
```js
|
|
||||||
const assert = require('assert');
|
|
||||||
const callBindBasic = require('call-bind-apply-helpers');
|
|
||||||
|
|
||||||
function f(a, b) {
|
|
||||||
assert.equal(this, 1);
|
|
||||||
assert.equal(a, 2);
|
|
||||||
assert.equal(b, 3);
|
|
||||||
assert.equal(arguments.length, 2);
|
|
||||||
}
|
|
||||||
|
|
||||||
const fBound = callBindBasic([f, 1]);
|
|
||||||
|
|
||||||
delete Function.prototype.call;
|
|
||||||
delete Function.prototype.bind;
|
|
||||||
|
|
||||||
fBound(2, 3);
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Clone the repo, `npm install`, and run `npm test`
|
|
||||||
|
|
||||||
[package-url]: https://npmjs.org/package/call-bind-apply-helpers
|
|
||||||
[npm-version-svg]: https://versionbadg.es/ljharb/call-bind-apply-helpers.svg
|
|
||||||
[deps-svg]: https://david-dm.org/ljharb/call-bind-apply-helpers.svg
|
|
||||||
[deps-url]: https://david-dm.org/ljharb/call-bind-apply-helpers
|
|
||||||
[dev-deps-svg]: https://david-dm.org/ljharb/call-bind-apply-helpers/dev-status.svg
|
|
||||||
[dev-deps-url]: https://david-dm.org/ljharb/call-bind-apply-helpers#info=devDependencies
|
|
||||||
[npm-badge-png]: https://nodei.co/npm/call-bind-apply-helpers.png?downloads=true&stars=true
|
|
||||||
[license-image]: https://img.shields.io/npm/l/call-bind-apply-helpers.svg
|
|
||||||
[license-url]: LICENSE
|
|
||||||
[downloads-image]: https://img.shields.io/npm/dm/call-bind-apply-helpers.svg
|
|
||||||
[downloads-url]: https://npm-stat.com/charts.html?package=call-bind-apply-helpers
|
|
||||||
[codecov-image]: https://codecov.io/gh/ljharb/call-bind-apply-helpers/branch/main/graphs/badge.svg
|
|
||||||
[codecov-url]: https://app.codecov.io/gh/ljharb/call-bind-apply-helpers/
|
|
||||||
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/call-bind-apply-helpers
|
|
||||||
[actions-url]: https://github.com/ljharb/call-bind-apply-helpers/actions
|
|
||||||
-1
@@ -1 +0,0 @@
|
|||||||
export = Reflect.apply;
|
|
||||||
-10
@@ -1,10 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
var bind = require('function-bind');
|
|
||||||
|
|
||||||
var $apply = require('./functionApply');
|
|
||||||
var $call = require('./functionCall');
|
|
||||||
var $reflectApply = require('./reflectApply');
|
|
||||||
|
|
||||||
/** @type {import('./actualApply')} */
|
|
||||||
module.exports = $reflectApply || bind.call($call, $apply);
|
|
||||||
-19
@@ -1,19 +0,0 @@
|
|||||||
import actualApply from './actualApply';
|
|
||||||
|
|
||||||
type TupleSplitHead<T extends any[], N extends number> = T['length'] extends N
|
|
||||||
? T
|
|
||||||
: T extends [...infer R, any]
|
|
||||||
? TupleSplitHead<R, N>
|
|
||||||
: never
|
|
||||||
|
|
||||||
type TupleSplitTail<T, N extends number, O extends any[] = []> = O['length'] extends N
|
|
||||||
? T
|
|
||||||
: T extends [infer F, ...infer R]
|
|
||||||
? TupleSplitTail<[...R], N, [...O, F]>
|
|
||||||
: never
|
|
||||||
|
|
||||||
type TupleSplit<T extends any[], N extends number> = [TupleSplitHead<T, N>, TupleSplitTail<T, N>]
|
|
||||||
|
|
||||||
declare function applyBind(...args: TupleSplit<Parameters<typeof actualApply>, 2>[1]): ReturnType<typeof actualApply>;
|
|
||||||
|
|
||||||
export = applyBind;
|
|
||||||
-10
@@ -1,10 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
var bind = require('function-bind');
|
|
||||||
var $apply = require('./functionApply');
|
|
||||||
var actualApply = require('./actualApply');
|
|
||||||
|
|
||||||
/** @type {import('./applyBind')} */
|
|
||||||
module.exports = function applyBind() {
|
|
||||||
return actualApply(bind, $apply, arguments);
|
|
||||||
};
|
|
||||||
-1
@@ -1 +0,0 @@
|
|||||||
export = Function.prototype.apply;
|
|
||||||
-4
@@ -1,4 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
/** @type {import('./functionApply')} */
|
|
||||||
module.exports = Function.prototype.apply;
|
|
||||||
-1
@@ -1 +0,0 @@
|
|||||||
export = Function.prototype.call;
|
|
||||||
-4
@@ -1,4 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
/** @type {import('./functionCall')} */
|
|
||||||
module.exports = Function.prototype.call;
|
|
||||||
-64
@@ -1,64 +0,0 @@
|
|||||||
type RemoveFromTuple<
|
|
||||||
Tuple extends readonly unknown[],
|
|
||||||
RemoveCount extends number,
|
|
||||||
Index extends 1[] = []
|
|
||||||
> = Index["length"] extends RemoveCount
|
|
||||||
? Tuple
|
|
||||||
: Tuple extends [infer First, ...infer Rest]
|
|
||||||
? RemoveFromTuple<Rest, RemoveCount, [...Index, 1]>
|
|
||||||
: Tuple;
|
|
||||||
|
|
||||||
type ConcatTuples<
|
|
||||||
Prefix extends readonly unknown[],
|
|
||||||
Suffix extends readonly unknown[]
|
|
||||||
> = [...Prefix, ...Suffix];
|
|
||||||
|
|
||||||
type ExtractFunctionParams<T> = T extends (this: infer TThis, ...args: infer P extends readonly unknown[]) => infer R
|
|
||||||
? { thisArg: TThis; params: P; returnType: R }
|
|
||||||
: never;
|
|
||||||
|
|
||||||
type BindFunction<
|
|
||||||
T extends (this: any, ...args: any[]) => any,
|
|
||||||
TThis,
|
|
||||||
TBoundArgs extends readonly unknown[],
|
|
||||||
ReceiverBound extends boolean
|
|
||||||
> = ExtractFunctionParams<T> extends {
|
|
||||||
thisArg: infer OrigThis;
|
|
||||||
params: infer P extends readonly unknown[];
|
|
||||||
returnType: infer R;
|
|
||||||
}
|
|
||||||
? ReceiverBound extends true
|
|
||||||
? (...args: RemoveFromTuple<P, Extract<TBoundArgs["length"], number>>) => R extends [OrigThis, ...infer Rest]
|
|
||||||
? [TThis, ...Rest] // Replace `this` with `thisArg`
|
|
||||||
: R
|
|
||||||
: <U, RemainingArgs extends RemoveFromTuple<P, Extract<TBoundArgs["length"], number>>>(
|
|
||||||
thisArg: U,
|
|
||||||
...args: RemainingArgs
|
|
||||||
) => R extends [OrigThis, ...infer Rest]
|
|
||||||
? [U, ...ConcatTuples<TBoundArgs, Rest>] // Preserve bound args in return type
|
|
||||||
: R
|
|
||||||
: never;
|
|
||||||
|
|
||||||
declare function callBind<
|
|
||||||
const T extends (this: any, ...args: any[]) => any,
|
|
||||||
Extracted extends ExtractFunctionParams<T>,
|
|
||||||
const TBoundArgs extends Partial<Extracted["params"]> & readonly unknown[],
|
|
||||||
const TThis extends Extracted["thisArg"]
|
|
||||||
>(
|
|
||||||
args: [fn: T, thisArg: TThis, ...boundArgs: TBoundArgs]
|
|
||||||
): BindFunction<T, TThis, TBoundArgs, true>;
|
|
||||||
|
|
||||||
declare function callBind<
|
|
||||||
const T extends (this: any, ...args: any[]) => any,
|
|
||||||
Extracted extends ExtractFunctionParams<T>,
|
|
||||||
const TBoundArgs extends Partial<Extracted["params"]> & readonly unknown[]
|
|
||||||
>(
|
|
||||||
args: [fn: T, ...boundArgs: TBoundArgs]
|
|
||||||
): BindFunction<T, Extracted["thisArg"], TBoundArgs, false>;
|
|
||||||
|
|
||||||
declare function callBind<const TArgs extends readonly unknown[]>(
|
|
||||||
args: [fn: Exclude<TArgs[0], Function>, ...rest: TArgs]
|
|
||||||
): never;
|
|
||||||
|
|
||||||
// export as namespace callBind;
|
|
||||||
export = callBind;
|
|
||||||
-15
@@ -1,15 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
var bind = require('function-bind');
|
|
||||||
var $TypeError = require('es-errors/type');
|
|
||||||
|
|
||||||
var $call = require('./functionCall');
|
|
||||||
var $actualApply = require('./actualApply');
|
|
||||||
|
|
||||||
/** @type {(args: [Function, thisArg?: unknown, ...args: unknown[]]) => Function} TODO FIXME, find a way to use import('.') */
|
|
||||||
module.exports = function callBindBasic(args) {
|
|
||||||
if (args.length < 1 || typeof args[0] !== 'function') {
|
|
||||||
throw new $TypeError('a function is required');
|
|
||||||
}
|
|
||||||
return $actualApply(bind, $call, args);
|
|
||||||
};
|
|
||||||
-85
@@ -1,85 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "call-bind-apply-helpers",
|
|
||||||
"version": "1.0.2",
|
|
||||||
"description": "Helper functions around Function call/apply/bind, for use in `call-bind`",
|
|
||||||
"main": "index.js",
|
|
||||||
"exports": {
|
|
||||||
".": "./index.js",
|
|
||||||
"./actualApply": "./actualApply.js",
|
|
||||||
"./applyBind": "./applyBind.js",
|
|
||||||
"./functionApply": "./functionApply.js",
|
|
||||||
"./functionCall": "./functionCall.js",
|
|
||||||
"./reflectApply": "./reflectApply.js",
|
|
||||||
"./package.json": "./package.json"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"prepack": "npmignore --auto --commentLines=auto",
|
|
||||||
"prepublish": "not-in-publish || npm run prepublishOnly",
|
|
||||||
"prepublishOnly": "safe-publish-latest",
|
|
||||||
"prelint": "evalmd README.md",
|
|
||||||
"lint": "eslint --ext=.js,.mjs .",
|
|
||||||
"postlint": "tsc -p . && attw -P",
|
|
||||||
"pretest": "npm run lint",
|
|
||||||
"tests-only": "nyc tape 'test/**/*.js'",
|
|
||||||
"test": "npm run tests-only",
|
|
||||||
"posttest": "npx npm@'>=10.2' audit --production",
|
|
||||||
"version": "auto-changelog && git add CHANGELOG.md",
|
|
||||||
"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
|
|
||||||
},
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git+https://github.com/ljharb/call-bind-apply-helpers.git"
|
|
||||||
},
|
|
||||||
"author": "Jordan Harband <ljharb@gmail.com>",
|
|
||||||
"license": "MIT",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/ljharb/call-bind-apply-helpers/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/ljharb/call-bind-apply-helpers#readme",
|
|
||||||
"dependencies": {
|
|
||||||
"es-errors": "^1.3.0",
|
|
||||||
"function-bind": "^1.1.2"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@arethetypeswrong/cli": "^0.17.3",
|
|
||||||
"@ljharb/eslint-config": "^21.1.1",
|
|
||||||
"@ljharb/tsconfig": "^0.2.3",
|
|
||||||
"@types/for-each": "^0.3.3",
|
|
||||||
"@types/function-bind": "^1.1.10",
|
|
||||||
"@types/object-inspect": "^1.13.0",
|
|
||||||
"@types/tape": "^5.8.1",
|
|
||||||
"auto-changelog": "^2.5.0",
|
|
||||||
"encoding": "^0.1.13",
|
|
||||||
"es-value-fixtures": "^1.7.1",
|
|
||||||
"eslint": "=8.8.0",
|
|
||||||
"evalmd": "^0.0.19",
|
|
||||||
"for-each": "^0.3.5",
|
|
||||||
"has-strict-mode": "^1.1.0",
|
|
||||||
"in-publish": "^2.0.1",
|
|
||||||
"npmignore": "^0.3.1",
|
|
||||||
"nyc": "^10.3.2",
|
|
||||||
"object-inspect": "^1.13.4",
|
|
||||||
"safe-publish-latest": "^2.0.0",
|
|
||||||
"tape": "^5.9.0",
|
|
||||||
"typescript": "next"
|
|
||||||
},
|
|
||||||
"testling": {
|
|
||||||
"files": "test/index.js"
|
|
||||||
},
|
|
||||||
"auto-changelog": {
|
|
||||||
"output": "CHANGELOG.md",
|
|
||||||
"template": "keepachangelog",
|
|
||||||
"unreleased": false,
|
|
||||||
"commitLimit": false,
|
|
||||||
"backfillLimit": false,
|
|
||||||
"hideCredit": true
|
|
||||||
},
|
|
||||||
"publishConfig": {
|
|
||||||
"ignore": [
|
|
||||||
".github/workflows"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 0.4"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-3
@@ -1,3 +0,0 @@
|
|||||||
declare const reflectApply: false | typeof Reflect.apply;
|
|
||||||
|
|
||||||
export = reflectApply;
|
|
||||||
-4
@@ -1,4 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
/** @type {import('./reflectApply')} */
|
|
||||||
module.exports = typeof Reflect !== 'undefined' && Reflect && Reflect.apply;
|
|
||||||
-63
@@ -1,63 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
var callBind = require('../');
|
|
||||||
var hasStrictMode = require('has-strict-mode')();
|
|
||||||
var forEach = require('for-each');
|
|
||||||
var inspect = require('object-inspect');
|
|
||||||
var v = require('es-value-fixtures');
|
|
||||||
|
|
||||||
var test = require('tape');
|
|
||||||
|
|
||||||
test('callBindBasic', function (t) {
|
|
||||||
forEach(v.nonFunctions, function (nonFunction) {
|
|
||||||
t['throws'](
|
|
||||||
// @ts-expect-error
|
|
||||||
function () { callBind([nonFunction]); },
|
|
||||||
TypeError,
|
|
||||||
inspect(nonFunction) + ' is not a function'
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
var sentinel = { sentinel: true };
|
|
||||||
/** @type {<T, A extends number, B extends number>(this: T, a: A, b: B) => [T | undefined, A, B]} */
|
|
||||||
var func = function (a, b) {
|
|
||||||
// eslint-disable-next-line no-invalid-this
|
|
||||||
return [!hasStrictMode && this === global ? undefined : this, a, b];
|
|
||||||
};
|
|
||||||
t.equal(func.length, 2, 'original function length is 2');
|
|
||||||
|
|
||||||
/** type {(thisArg: unknown, a: number, b: number) => [unknown, number, number]} */
|
|
||||||
var bound = callBind([func]);
|
|
||||||
/** type {((a: number, b: number) => [typeof sentinel, typeof a, typeof b])} */
|
|
||||||
var boundR = callBind([func, sentinel]);
|
|
||||||
/** type {((b: number) => [typeof sentinel, number, typeof b])} */
|
|
||||||
var boundArg = callBind([func, sentinel, /** @type {const} */ (1)]);
|
|
||||||
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(bound(), [undefined, undefined, undefined], 'bound func with no args');
|
|
||||||
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(func(), [undefined, undefined, undefined], 'unbound func with too few args');
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(bound(1, 2), [hasStrictMode ? 1 : Object(1), 2, undefined], 'bound func too few args');
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(boundR(), [sentinel, undefined, undefined], 'bound func with receiver, with too few args');
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(boundArg(), [sentinel, 1, undefined], 'bound func with receiver and arg, with too few args');
|
|
||||||
|
|
||||||
t.deepEqual(func(1, 2), [undefined, 1, 2], 'unbound func with right args');
|
|
||||||
t.deepEqual(bound(1, 2, 3), [hasStrictMode ? 1 : Object(1), 2, 3], 'bound func with right args');
|
|
||||||
t.deepEqual(boundR(1, 2), [sentinel, 1, 2], 'bound func with receiver, with right args');
|
|
||||||
t.deepEqual(boundArg(2), [sentinel, 1, 2], 'bound func with receiver and arg, with right arg');
|
|
||||||
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(func(1, 2, 3), [undefined, 1, 2], 'unbound func with too many args');
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(bound(1, 2, 3, 4), [hasStrictMode ? 1 : Object(1), 2, 3], 'bound func with too many args');
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(boundR(1, 2, 3), [sentinel, 1, 2], 'bound func with receiver, with too many args');
|
|
||||||
// @ts-expect-error
|
|
||||||
t.deepEqual(boundArg(2, 3), [sentinel, 1, 2], 'bound func with receiver and arg, with too many args');
|
|
||||||
|
|
||||||
t.end();
|
|
||||||
});
|
|
||||||
-9
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "@ljharb/tsconfig",
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "es2021",
|
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"coverage",
|
|
||||||
],
|
|
||||||
}
|
|
||||||
-13
@@ -1,13 +0,0 @@
|
|||||||
{
|
|
||||||
"root": true,
|
|
||||||
|
|
||||||
"extends": "@ljharb",
|
|
||||||
|
|
||||||
"rules": {
|
|
||||||
"new-cap": [2, {
|
|
||||||
"capIsNewExceptions": [
|
|
||||||
"GetIntrinsic",
|
|
||||||
],
|
|
||||||
}],
|
|
||||||
},
|
|
||||||
}
|
|
||||||
-12
@@ -1,12 +0,0 @@
|
|||||||
# These are supported funding model platforms
|
|
||||||
|
|
||||||
github: [ljharb]
|
|
||||||
patreon: # Replace with a single Patreon username
|
|
||||||
open_collective: # Replace with a single Open Collective username
|
|
||||||
ko_fi: # Replace with a single Ko-fi username
|
|
||||||
tidelift: npm/call-bound
|
|
||||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
|
||||||
liberapay: # Replace with a single Liberapay username
|
|
||||||
issuehunt: # Replace with a single IssueHunt username
|
|
||||||
otechie: # Replace with a single Otechie username
|
|
||||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
|
||||||
-9
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"all": true,
|
|
||||||
"check-coverage": false,
|
|
||||||
"reporter": ["text-summary", "text", "html", "json"],
|
|
||||||
"exclude": [
|
|
||||||
"coverage",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
-42
@@ -1,42 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
|
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
||||||
|
|
||||||
## [v1.0.4](https://github.com/ljharb/call-bound/compare/v1.0.3...v1.0.4) - 2025-03-03
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
|
|
||||||
- [types] improve types [`e648922`](https://github.com/ljharb/call-bound/commit/e6489222a9e54f350fbf952ceabe51fd8b6027ff)
|
|
||||||
- [Dev Deps] update `@arethetypeswrong/cli`, `@ljharb/tsconfig`, `@types/tape`, `es-value-fixtures`, `for-each`, `has-strict-mode`, `object-inspect` [`a42a5eb`](https://github.com/ljharb/call-bound/commit/a42a5ebe6c1b54fcdc7997c7dc64fdca9e936719)
|
|
||||||
- [Deps] update `call-bind-apply-helpers`, `get-intrinsic` [`f529eac`](https://github.com/ljharb/call-bound/commit/f529eac132404c17156bbc23ab2297a25d0f20b8)
|
|
||||||
|
|
||||||
## [v1.0.3](https://github.com/ljharb/call-bound/compare/v1.0.2...v1.0.3) - 2024-12-15
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
|
|
||||||
- [Refactor] use `call-bind-apply-helpers` instead of `call-bind` [`5e0b134`](https://github.com/ljharb/call-bound/commit/5e0b13496df14fb7d05dae9412f088da8d3f75be)
|
|
||||||
- [Deps] update `get-intrinsic` [`41fc967`](https://github.com/ljharb/call-bound/commit/41fc96732a22c7b7e8f381f93ccc54bb6293be2e)
|
|
||||||
- [readme] fix example [`79a0137`](https://github.com/ljharb/call-bound/commit/79a0137723f7c6d09c9c05452bbf8d5efb5d6e49)
|
|
||||||
- [meta] add `sideEffects` flag [`08b07be`](https://github.com/ljharb/call-bound/commit/08b07be7f1c03f67dc6f3cdaf0906259771859f7)
|
|
||||||
|
|
||||||
## [v1.0.2](https://github.com/ljharb/call-bound/compare/v1.0.1...v1.0.2) - 2024-12-10
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
|
|
||||||
- [Dev Deps] update `@arethetypeswrong/cli`, `@ljharb/tsconfig`, `gopd` [`e6a5ffe`](https://github.com/ljharb/call-bound/commit/e6a5ffe849368fe4f74dfd6cdeca1b9baa39e8d5)
|
|
||||||
- [Deps] update `call-bind`, `get-intrinsic` [`2aeb5b5`](https://github.com/ljharb/call-bound/commit/2aeb5b521dc2b2683d1345c753ea1161de2d1c14)
|
|
||||||
- [types] improve return type [`1a0c9fe`](https://github.com/ljharb/call-bound/commit/1a0c9fe3114471e7ca1f57d104e2efe713bb4871)
|
|
||||||
|
|
||||||
## v1.0.1 - 2024-12-05
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
|
|
||||||
- Initial implementation, tests, readme, types [`6d94121`](https://github.com/ljharb/call-bound/commit/6d94121a9243602e506334069f7a03189fe3363d)
|
|
||||||
- Initial commit [`0eae867`](https://github.com/ljharb/call-bound/commit/0eae867334ea025c33e6e91cdecfc9df96680cf9)
|
|
||||||
- npm init [`71b2479`](https://github.com/ljharb/call-bound/commit/71b2479c6723e0b7d91a6b663613067e98b7b275)
|
|
||||||
- Only apps should have lockfiles [`c3754a9`](https://github.com/ljharb/call-bound/commit/c3754a949b7f9132b47e2d18c1729889736741eb)
|
|
||||||
- [actions] skip `npm ls` in node < 10 [`74275a5`](https://github.com/ljharb/call-bound/commit/74275a5186b8caf6309b6b97472bdcb0df4683a8)
|
|
||||||
- [Dev Deps] add missing peer dep [`1354de8`](https://github.com/ljharb/call-bound/commit/1354de8679413e4ae9c523d85f76fa7a5e032d97)
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2024 Jordan Harband
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
-53
@@ -1,53 +0,0 @@
|
|||||||
# call-bound <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
|
||||||
|
|
||||||
[![github actions][actions-image]][actions-url]
|
|
||||||
[![coverage][codecov-image]][codecov-url]
|
|
||||||
[![dependency status][deps-svg]][deps-url]
|
|
||||||
[![dev dependency status][dev-deps-svg]][dev-deps-url]
|
|
||||||
[![License][license-image]][license-url]
|
|
||||||
[![Downloads][downloads-image]][downloads-url]
|
|
||||||
|
|
||||||
[![npm badge][npm-badge-png]][package-url]
|
|
||||||
|
|
||||||
Robust call-bound JavaScript intrinsics, using `call-bind` and `get-intrinsic`.
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install --save call-bound
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage/Examples
|
|
||||||
|
|
||||||
```js
|
|
||||||
const assert = require('assert');
|
|
||||||
const callBound = require('call-bound');
|
|
||||||
|
|
||||||
const slice = callBound('Array.prototype.slice');
|
|
||||||
|
|
||||||
delete Function.prototype.call;
|
|
||||||
delete Function.prototype.bind;
|
|
||||||
delete Array.prototype.slice;
|
|
||||||
|
|
||||||
assert.deepEqual(slice([1, 2, 3, 4], 1, -1), [2, 3]);
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Clone the repo, `npm install`, and run `npm test`
|
|
||||||
|
|
||||||
[package-url]: https://npmjs.org/package/call-bound
|
|
||||||
[npm-version-svg]: https://versionbadg.es/ljharb/call-bound.svg
|
|
||||||
[deps-svg]: https://david-dm.org/ljharb/call-bound.svg
|
|
||||||
[deps-url]: https://david-dm.org/ljharb/call-bound
|
|
||||||
[dev-deps-svg]: https://david-dm.org/ljharb/call-bound/dev-status.svg
|
|
||||||
[dev-deps-url]: https://david-dm.org/ljharb/call-bound#info=devDependencies
|
|
||||||
[npm-badge-png]: https://nodei.co/npm/call-bound.png?downloads=true&stars=true
|
|
||||||
[license-image]: https://img.shields.io/npm/l/call-bound.svg
|
|
||||||
[license-url]: LICENSE
|
|
||||||
[downloads-image]: https://img.shields.io/npm/dm/call-bound.svg
|
|
||||||
[downloads-url]: https://npm-stat.com/charts.html?package=call-bound
|
|
||||||
[codecov-image]: https://codecov.io/gh/ljharb/call-bound/branch/main/graphs/badge.svg
|
|
||||||
[codecov-url]: https://app.codecov.io/gh/ljharb/call-bound/
|
|
||||||
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/call-bound
|
|
||||||
[actions-url]: https://github.com/ljharb/call-bound/actions
|
|
||||||
-94
@@ -1,94 +0,0 @@
|
|||||||
type Intrinsic = typeof globalThis;
|
|
||||||
|
|
||||||
type IntrinsicName = keyof Intrinsic | `%${keyof Intrinsic}%`;
|
|
||||||
|
|
||||||
type IntrinsicPath = IntrinsicName | `${StripPercents<IntrinsicName>}.${string}` | `%${StripPercents<IntrinsicName>}.${string}%`;
|
|
||||||
|
|
||||||
type AllowMissing = boolean;
|
|
||||||
|
|
||||||
type StripPercents<T extends string> = T extends `%${infer U}%` ? U : T;
|
|
||||||
|
|
||||||
type BindMethodPrecise<F> =
|
|
||||||
F extends (this: infer This, ...args: infer Args) => infer R
|
|
||||||
? (obj: This, ...args: Args) => R
|
|
||||||
: F extends {
|
|
||||||
(this: infer This1, ...args: infer Args1): infer R1;
|
|
||||||
(this: infer This2, ...args: infer Args2): infer R2
|
|
||||||
}
|
|
||||||
? {
|
|
||||||
(obj: This1, ...args: Args1): R1;
|
|
||||||
(obj: This2, ...args: Args2): R2
|
|
||||||
}
|
|
||||||
: never
|
|
||||||
|
|
||||||
// Extract method type from a prototype
|
|
||||||
type GetPrototypeMethod<T extends keyof typeof globalThis, M extends string> =
|
|
||||||
(typeof globalThis)[T] extends { prototype: any }
|
|
||||||
? M extends keyof (typeof globalThis)[T]['prototype']
|
|
||||||
? (typeof globalThis)[T]['prototype'][M]
|
|
||||||
: never
|
|
||||||
: never
|
|
||||||
|
|
||||||
// Get static property/method
|
|
||||||
type GetStaticMember<T extends keyof typeof globalThis, P extends string> =
|
|
||||||
P extends keyof (typeof globalThis)[T] ? (typeof globalThis)[T][P] : never
|
|
||||||
|
|
||||||
// Type that maps string path to actual bound function or value with better precision
|
|
||||||
type BoundIntrinsic<S extends string> =
|
|
||||||
S extends `${infer Obj}.prototype.${infer Method}`
|
|
||||||
? Obj extends keyof typeof globalThis
|
|
||||||
? BindMethodPrecise<GetPrototypeMethod<Obj, Method & string>>
|
|
||||||
: unknown
|
|
||||||
: S extends `${infer Obj}.${infer Prop}`
|
|
||||||
? Obj extends keyof typeof globalThis
|
|
||||||
? GetStaticMember<Obj, Prop & string>
|
|
||||||
: unknown
|
|
||||||
: unknown
|
|
||||||
|
|
||||||
declare function arraySlice<T>(array: readonly T[], start?: number, end?: number): T[];
|
|
||||||
declare function arraySlice<T>(array: ArrayLike<T>, start?: number, end?: number): T[];
|
|
||||||
declare function arraySlice<T>(array: IArguments, start?: number, end?: number): T[];
|
|
||||||
|
|
||||||
// Special cases for methods that need explicit typing
|
|
||||||
interface SpecialCases {
|
|
||||||
'%Object.prototype.isPrototypeOf%': (thisArg: {}, obj: unknown) => boolean;
|
|
||||||
'%String.prototype.replace%': {
|
|
||||||
(str: string, searchValue: string | RegExp, replaceValue: string): string;
|
|
||||||
(str: string, searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string
|
|
||||||
};
|
|
||||||
'%Object.prototype.toString%': (obj: {}) => string;
|
|
||||||
'%Object.prototype.hasOwnProperty%': (obj: {}, v: PropertyKey) => boolean;
|
|
||||||
'%Array.prototype.slice%': typeof arraySlice;
|
|
||||||
'%Array.prototype.map%': <T, U>(array: readonly T[], callbackfn: (value: T, index: number, array: readonly T[]) => U, thisArg?: any) => U[];
|
|
||||||
'%Array.prototype.filter%': <T>(array: readonly T[], predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any) => T[];
|
|
||||||
'%Array.prototype.indexOf%': <T>(array: readonly T[], searchElement: T, fromIndex?: number) => number;
|
|
||||||
'%Function.prototype.apply%': <T, A extends any[], R>(fn: (...args: A) => R, thisArg: any, args: A) => R;
|
|
||||||
'%Function.prototype.call%': <T, A extends any[], R>(fn: (...args: A) => R, thisArg: any, ...args: A) => R;
|
|
||||||
'%Function.prototype.bind%': <T, A extends any[], R>(fn: (...args: A) => R, thisArg: any, ...args: A) => (...remainingArgs: A) => R;
|
|
||||||
'%Promise.prototype.then%': {
|
|
||||||
<T, R>(promise: Promise<T>, onfulfilled: (value: T) => R | PromiseLike<R>): Promise<R>;
|
|
||||||
<T, R>(promise: Promise<T>, onfulfilled: ((value: T) => R | PromiseLike<R>) | undefined | null, onrejected: (reason: any) => R | PromiseLike<R>): Promise<R>;
|
|
||||||
};
|
|
||||||
'%RegExp.prototype.test%': (regexp: RegExp, str: string) => boolean;
|
|
||||||
'%RegExp.prototype.exec%': (regexp: RegExp, str: string) => RegExpExecArray | null;
|
|
||||||
'%Error.prototype.toString%': (error: Error) => string;
|
|
||||||
'%TypeError.prototype.toString%': (error: TypeError) => string;
|
|
||||||
'%String.prototype.split%': (
|
|
||||||
obj: unknown,
|
|
||||||
splitter: string | RegExp | {
|
|
||||||
[Symbol.split](string: string, limit?: number): string[];
|
|
||||||
},
|
|
||||||
limit?: number | undefined
|
|
||||||
) => string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a bound function for a prototype method, or a value for a static property.
|
|
||||||
*
|
|
||||||
* @param name - The name of the intrinsic (e.g. 'Array.prototype.slice')
|
|
||||||
* @param {AllowMissing} [allowMissing] - Whether to allow missing intrinsics (default: false)
|
|
||||||
*/
|
|
||||||
declare function callBound<K extends keyof SpecialCases | StripPercents<keyof SpecialCases>, S extends IntrinsicPath>(name: K, allowMissing?: AllowMissing): SpecialCases[`%${StripPercents<K>}%`];
|
|
||||||
declare function callBound<K extends keyof SpecialCases | StripPercents<keyof SpecialCases>, S extends IntrinsicPath>(name: S, allowMissing?: AllowMissing): BoundIntrinsic<S>;
|
|
||||||
|
|
||||||
export = callBound;
|
|
||||||
-19
@@ -1,19 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
var GetIntrinsic = require('get-intrinsic');
|
|
||||||
|
|
||||||
var callBindBasic = require('call-bind-apply-helpers');
|
|
||||||
|
|
||||||
/** @type {(thisArg: string, searchString: string, position?: number) => number} */
|
|
||||||
var $indexOf = callBindBasic([GetIntrinsic('%String.prototype.indexOf%')]);
|
|
||||||
|
|
||||||
/** @type {import('.')} */
|
|
||||||
module.exports = function callBoundIntrinsic(name, allowMissing) {
|
|
||||||
/* eslint no-extra-parens: 0 */
|
|
||||||
|
|
||||||
var intrinsic = /** @type {(this: unknown, ...args: unknown[]) => unknown} */ (GetIntrinsic(name, !!allowMissing));
|
|
||||||
if (typeof intrinsic === 'function' && $indexOf(name, '.prototype.') > -1) {
|
|
||||||
return callBindBasic(/** @type {const} */ ([intrinsic]));
|
|
||||||
}
|
|
||||||
return intrinsic;
|
|
||||||
};
|
|
||||||
-99
@@ -1,99 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "call-bound",
|
|
||||||
"version": "1.0.4",
|
|
||||||
"description": "Robust call-bound JavaScript intrinsics, using `call-bind` and `get-intrinsic`.",
|
|
||||||
"main": "index.js",
|
|
||||||
"exports": {
|
|
||||||
".": "./index.js",
|
|
||||||
"./package.json": "./package.json"
|
|
||||||
},
|
|
||||||
"sideEffects": false,
|
|
||||||
"scripts": {
|
|
||||||
"prepack": "npmignore --auto --commentLines=auto",
|
|
||||||
"prepublish": "not-in-publish || npm run prepublishOnly",
|
|
||||||
"prepublishOnly": "safe-publish-latest",
|
|
||||||
"prelint": "evalmd README.md",
|
|
||||||
"lint": "eslint --ext=.js,.mjs .",
|
|
||||||
"postlint": "tsc -p . && attw -P",
|
|
||||||
"pretest": "npm run lint",
|
|
||||||
"tests-only": "nyc tape 'test/**/*.js'",
|
|
||||||
"test": "npm run tests-only",
|
|
||||||
"posttest": "npx npm@'>=10.2' audit --production",
|
|
||||||
"version": "auto-changelog && git add CHANGELOG.md",
|
|
||||||
"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
|
|
||||||
},
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git+https://github.com/ljharb/call-bound.git"
|
|
||||||
},
|
|
||||||
"keywords": [
|
|
||||||
"javascript",
|
|
||||||
"ecmascript",
|
|
||||||
"es",
|
|
||||||
"js",
|
|
||||||
"callbind",
|
|
||||||
"callbound",
|
|
||||||
"call",
|
|
||||||
"bind",
|
|
||||||
"bound",
|
|
||||||
"call-bind",
|
|
||||||
"call-bound",
|
|
||||||
"function",
|
|
||||||
"es-abstract"
|
|
||||||
],
|
|
||||||
"author": "Jordan Harband <ljharb@gmail.com>",
|
|
||||||
"funding": {
|
|
||||||
"url": "https://github.com/sponsors/ljharb"
|
|
||||||
},
|
|
||||||
"license": "MIT",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/ljharb/call-bound/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/ljharb/call-bound#readme",
|
|
||||||
"dependencies": {
|
|
||||||
"call-bind-apply-helpers": "^1.0.2",
|
|
||||||
"get-intrinsic": "^1.3.0"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@arethetypeswrong/cli": "^0.17.4",
|
|
||||||
"@ljharb/eslint-config": "^21.1.1",
|
|
||||||
"@ljharb/tsconfig": "^0.3.0",
|
|
||||||
"@types/call-bind": "^1.0.5",
|
|
||||||
"@types/get-intrinsic": "^1.2.3",
|
|
||||||
"@types/tape": "^5.8.1",
|
|
||||||
"auto-changelog": "^2.5.0",
|
|
||||||
"encoding": "^0.1.13",
|
|
||||||
"es-value-fixtures": "^1.7.1",
|
|
||||||
"eslint": "=8.8.0",
|
|
||||||
"evalmd": "^0.0.19",
|
|
||||||
"for-each": "^0.3.5",
|
|
||||||
"gopd": "^1.2.0",
|
|
||||||
"has-strict-mode": "^1.1.0",
|
|
||||||
"in-publish": "^2.0.1",
|
|
||||||
"npmignore": "^0.3.1",
|
|
||||||
"nyc": "^10.3.2",
|
|
||||||
"object-inspect": "^1.13.4",
|
|
||||||
"safe-publish-latest": "^2.0.0",
|
|
||||||
"tape": "^5.9.0",
|
|
||||||
"typescript": "next"
|
|
||||||
},
|
|
||||||
"testling": {
|
|
||||||
"files": "test/index.js"
|
|
||||||
},
|
|
||||||
"auto-changelog": {
|
|
||||||
"output": "CHANGELOG.md",
|
|
||||||
"template": "keepachangelog",
|
|
||||||
"unreleased": false,
|
|
||||||
"commitLimit": false,
|
|
||||||
"backfillLimit": false,
|
|
||||||
"hideCredit": true
|
|
||||||
},
|
|
||||||
"publishConfig": {
|
|
||||||
"ignore": [
|
|
||||||
".github/workflows"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 0.4"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-61
@@ -1,61 +0,0 @@
|
|||||||
'use strict';
|
|
||||||
|
|
||||||
var test = require('tape');
|
|
||||||
|
|
||||||
var callBound = require('../');
|
|
||||||
|
|
||||||
/** @template {true} T @template U @typedef {T extends U ? T : never} AssertType */
|
|
||||||
|
|
||||||
test('callBound', function (t) {
|
|
||||||
// static primitive
|
|
||||||
t.equal(callBound('Array.length'), Array.length, 'Array.length yields itself');
|
|
||||||
t.equal(callBound('%Array.length%'), Array.length, '%Array.length% yields itself');
|
|
||||||
|
|
||||||
// static non-function object
|
|
||||||
t.equal(callBound('Array.prototype'), Array.prototype, 'Array.prototype yields itself');
|
|
||||||
t.equal(callBound('%Array.prototype%'), Array.prototype, '%Array.prototype% yields itself');
|
|
||||||
t.equal(callBound('Array.constructor'), Array.constructor, 'Array.constructor yields itself');
|
|
||||||
t.equal(callBound('%Array.constructor%'), Array.constructor, '%Array.constructor% yields itself');
|
|
||||||
|
|
||||||
// static function
|
|
||||||
t.equal(callBound('Date.parse'), Date.parse, 'Date.parse yields itself');
|
|
||||||
t.equal(callBound('%Date.parse%'), Date.parse, '%Date.parse% yields itself');
|
|
||||||
|
|
||||||
// prototype primitive
|
|
||||||
t.equal(callBound('Error.prototype.message'), Error.prototype.message, 'Error.prototype.message yields itself');
|
|
||||||
t.equal(callBound('%Error.prototype.message%'), Error.prototype.message, '%Error.prototype.message% yields itself');
|
|
||||||
|
|
||||||
var x = callBound('Object.prototype.toString');
|
|
||||||
var y = callBound('%Object.prototype.toString%');
|
|
||||||
|
|
||||||
// prototype function
|
|
||||||
t.notEqual(x, Object.prototype.toString, 'Object.prototype.toString does not yield itself');
|
|
||||||
t.notEqual(y, Object.prototype.toString, '%Object.prototype.toString% does not yield itself');
|
|
||||||
t.equal(x(true), Object.prototype.toString.call(true), 'call-bound Object.prototype.toString calls into the original');
|
|
||||||
t.equal(y(true), Object.prototype.toString.call(true), 'call-bound %Object.prototype.toString% calls into the original');
|
|
||||||
|
|
||||||
t['throws'](
|
|
||||||
// @ts-expect-error
|
|
||||||
function () { callBound('does not exist'); },
|
|
||||||
SyntaxError,
|
|
||||||
'nonexistent intrinsic throws'
|
|
||||||
);
|
|
||||||
t['throws'](
|
|
||||||
// @ts-expect-error
|
|
||||||
function () { callBound('does not exist', true); },
|
|
||||||
SyntaxError,
|
|
||||||
'allowMissing arg still throws for unknown intrinsic'
|
|
||||||
);
|
|
||||||
|
|
||||||
t.test('real but absent intrinsic', { skip: typeof WeakRef !== 'undefined' }, function (st) {
|
|
||||||
st['throws'](
|
|
||||||
function () { callBound('WeakRef'); },
|
|
||||||
TypeError,
|
|
||||||
'real but absent intrinsic throws'
|
|
||||||
);
|
|
||||||
st.equal(callBound('WeakRef', true), undefined, 'allowMissing arg avoids exception');
|
|
||||||
st.end();
|
|
||||||
});
|
|
||||||
|
|
||||||
t.end();
|
|
||||||
});
|
|
||||||
-10
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "@ljharb/tsconfig",
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "ESNext",
|
|
||||||
"lib": ["es2024"],
|
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"coverage",
|
|
||||||
],
|
|
||||||
}
|
|
||||||
-19
@@ -1,19 +0,0 @@
|
|||||||
Copyright (c) 2011 Debuggable Limited <felix@debuggable.com>
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
||||||
-138
@@ -1,138 +0,0 @@
|
|||||||
# combined-stream
|
|
||||||
|
|
||||||
A stream that emits multiple other streams one after another.
|
|
||||||
|
|
||||||
**NB** Currently `combined-stream` works with streams version 1 only. There is ongoing effort to switch this library to streams version 2. Any help is welcome. :) Meanwhile you can explore other libraries that provide streams2 support with more or less compatibility with `combined-stream`.
|
|
||||||
|
|
||||||
- [combined-stream2](https://www.npmjs.com/package/combined-stream2): A drop-in streams2-compatible replacement for the combined-stream module.
|
|
||||||
|
|
||||||
- [multistream](https://www.npmjs.com/package/multistream): A stream that emits multiple other streams one after another.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
npm install combined-stream
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Here is a simple example that shows how you can use combined-stream to combine
|
|
||||||
two files into one:
|
|
||||||
|
|
||||||
``` javascript
|
|
||||||
var CombinedStream = require('combined-stream');
|
|
||||||
var fs = require('fs');
|
|
||||||
|
|
||||||
var combinedStream = CombinedStream.create();
|
|
||||||
combinedStream.append(fs.createReadStream('file1.txt'));
|
|
||||||
combinedStream.append(fs.createReadStream('file2.txt'));
|
|
||||||
|
|
||||||
combinedStream.pipe(fs.createWriteStream('combined.txt'));
|
|
||||||
```
|
|
||||||
|
|
||||||
While the example above works great, it will pause all source streams until
|
|
||||||
they are needed. If you don't want that to happen, you can set `pauseStreams`
|
|
||||||
to `false`:
|
|
||||||
|
|
||||||
``` javascript
|
|
||||||
var CombinedStream = require('combined-stream');
|
|
||||||
var fs = require('fs');
|
|
||||||
|
|
||||||
var combinedStream = CombinedStream.create({pauseStreams: false});
|
|
||||||
combinedStream.append(fs.createReadStream('file1.txt'));
|
|
||||||
combinedStream.append(fs.createReadStream('file2.txt'));
|
|
||||||
|
|
||||||
combinedStream.pipe(fs.createWriteStream('combined.txt'));
|
|
||||||
```
|
|
||||||
|
|
||||||
However, what if you don't have all the source streams yet, or you don't want
|
|
||||||
to allocate the resources (file descriptors, memory, etc.) for them right away?
|
|
||||||
Well, in that case you can simply provide a callback that supplies the stream
|
|
||||||
by calling a `next()` function:
|
|
||||||
|
|
||||||
``` javascript
|
|
||||||
var CombinedStream = require('combined-stream');
|
|
||||||
var fs = require('fs');
|
|
||||||
|
|
||||||
var combinedStream = CombinedStream.create();
|
|
||||||
combinedStream.append(function(next) {
|
|
||||||
next(fs.createReadStream('file1.txt'));
|
|
||||||
});
|
|
||||||
combinedStream.append(function(next) {
|
|
||||||
next(fs.createReadStream('file2.txt'));
|
|
||||||
});
|
|
||||||
|
|
||||||
combinedStream.pipe(fs.createWriteStream('combined.txt'));
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### CombinedStream.create([options])
|
|
||||||
|
|
||||||
Returns a new combined stream object. Available options are:
|
|
||||||
|
|
||||||
* `maxDataSize`
|
|
||||||
* `pauseStreams`
|
|
||||||
|
|
||||||
The effect of those options is described below.
|
|
||||||
|
|
||||||
### combinedStream.pauseStreams = `true`
|
|
||||||
|
|
||||||
Whether to apply back pressure to the underlaying streams. If set to `false`,
|
|
||||||
the underlaying streams will never be paused. If set to `true`, the
|
|
||||||
underlaying streams will be paused right after being appended, as well as when
|
|
||||||
`delayedStream.pipe()` wants to throttle.
|
|
||||||
|
|
||||||
### combinedStream.maxDataSize = `2 * 1024 * 1024`
|
|
||||||
|
|
||||||
The maximum amount of bytes (or characters) to buffer for all source streams.
|
|
||||||
If this value is exceeded, `combinedStream` emits an `'error'` event.
|
|
||||||
|
|
||||||
### combinedStream.dataSize = `0`
|
|
||||||
|
|
||||||
The amount of bytes (or characters) currently buffered by `combinedStream`.
|
|
||||||
|
|
||||||
### combinedStream.append(stream)
|
|
||||||
|
|
||||||
Appends the given `stream` to the combinedStream object. If `pauseStreams` is
|
|
||||||
set to `true, this stream will also be paused right away.
|
|
||||||
|
|
||||||
`streams` can also be a function that takes one parameter called `next`. `next`
|
|
||||||
is a function that must be invoked in order to provide the `next` stream, see
|
|
||||||
example above.
|
|
||||||
|
|
||||||
Regardless of how the `stream` is appended, combined-stream always attaches an
|
|
||||||
`'error'` listener to it, so you don't have to do that manually.
|
|
||||||
|
|
||||||
Special case: `stream` can also be a String or Buffer.
|
|
||||||
|
|
||||||
### combinedStream.write(data)
|
|
||||||
|
|
||||||
You should not call this, `combinedStream` takes care of piping the appended
|
|
||||||
streams into itself for you.
|
|
||||||
|
|
||||||
### combinedStream.resume()
|
|
||||||
|
|
||||||
Causes `combinedStream` to start drain the streams it manages. The function is
|
|
||||||
idempotent, and also emits a `'resume'` event each time which usually goes to
|
|
||||||
the stream that is currently being drained.
|
|
||||||
|
|
||||||
### combinedStream.pause();
|
|
||||||
|
|
||||||
If `combinedStream.pauseStreams` is set to `false`, this does nothing.
|
|
||||||
Otherwise a `'pause'` event is emitted, this goes to the stream that is
|
|
||||||
currently being drained, so you can use it to apply back pressure.
|
|
||||||
|
|
||||||
### combinedStream.end();
|
|
||||||
|
|
||||||
Sets `combinedStream.writable` to false, emits an `'end'` event, and removes
|
|
||||||
all streams from the queue.
|
|
||||||
|
|
||||||
### combinedStream.destroy();
|
|
||||||
|
|
||||||
Same as `combinedStream.end()`, except it emits a `'close'` event instead of
|
|
||||||
`'end'`.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
combined-stream is licensed under the MIT license.
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user