GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — buffer: add end parameter · nodejs/node@e2eb88b

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • doc/api
    • buffer.md
  • lib
    • buffer.js
  • src
    • node_buffer.cc
  • test/parallel
    • test-buffer-indexof.js
  • typings/internalBinding
    • buffer.d.ts
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎doc/api/buffer.md‎

Copy file name to clipboardExpand all lines: doc/api/buffer.md
+21-6Lines changed: 21 additions & 6 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -2085,19 +2085,24 @@ console.log(buf.fill('zz', 'hex'));
20852085
// Throws an exception.
20862086
```
20872087

2088-
### `buf.includes(value[, byteOffset][, encoding])`
2088+
### `buf.includes(value[, start[, end]][, encoding])`
20892089

20902090
<!-- YAML
20912091
added: v5.3.0
20922092
changes:
2093+
- version: REPLACEME
2094+
pr-url: https://github.com/nodejs/node/pull/62390
2095+
description: Added the `end` parameter.
20932096
- version: v24.13.1
20942097
pr-url: https://github.com/nodejs/node/pull/56578
20952098
description: supports Uint8Array as `this` value.
20962099
-->
20972100

20982101
* `value` {string|Buffer|Uint8Array|integer} What to search for.
2099-
* `byteOffset` {integer} Where to begin searching in `buf`. If negative, then
2102+
* `start` {integer} Where to begin searching in `buf`. If negative, then
21002103
offset is calculated from the end of `buf`. **Default:** `0`.
2104+
* `end` {integer} Where to stop searching in `buf` (exclusive). **Default:**
2105+
`buf.length`.
21012106
* `encoding` {string} If `value` is a string, this is its encoding.
21022107
**Default:** `'utf8'`.
21032108
* Returns: {boolean} `true` if `value` was found in `buf`, `false` otherwise.
@@ -2146,11 +2151,14 @@ console.log(buf.includes('this', 4));
21462151
// Prints: false
21472152
```
21482153

2149-
### `buf.indexOf(value[, byteOffset][, encoding])`
2154+
### `buf.indexOf(value[, start[, end]][, encoding])`
21502155

21512156
<!-- YAML
21522157
added: v1.5.0
21532158
changes:
2159+
- version: REPLACEME
2160+
pr-url: https://github.com/nodejs/node/pull/62390
2161+
description: Added the `end` parameter.
21542162
- version: v8.0.0
21552163
pr-url: https://github.com/nodejs/node/pull/10236
21562164
description: The `value` can now be a `Uint8Array`.
@@ -2163,8 +2171,10 @@ changes:
21632171
-->
21642172

21652173
* `value` {string|Buffer|Uint8Array|integer} What to search for.
2166-
* `byteOffset` {integer} Where to begin searching in `buf`. If negative, then
2174+
* `start` {integer} Where to begin searching in `buf`. If negative, then
21672175
offset is calculated from the end of `buf`. **Default:** `0`.
2176+
* `end` {integer} Where to stop searching in `buf` (exclusive). **Default:**
2177+
`buf.length`.
21682178
* `encoding` {string} If `value` is a string, this is the encoding used to
21692179
determine the binary representation of the string that will be searched for in
21702180
`buf`. **Default:** `'utf8'`.
@@ -2324,20 +2334,25 @@ for (const key of buf.keys()) {
23242334
// 5
23252335
```
23262336

2327-
### `buf.lastIndexOf(value[, byteOffset][, encoding])`
2337+
### `buf.lastIndexOf(value[, start[, end]][, encoding])`
23282338

23292339
<!-- YAML
23302340
added: v6.0.0
23312341
changes:
2342+
- version: REPLACEME
2343+
pr-url: https://github.com/nodejs/node/pull/62390
2344+
description: Added the `end` parameter.
23322345
- version: v8.0.0
23332346
pr-url: https://github.com/nodejs/node/pull/10236
23342347
description: The `value` can now be a `Uint8Array`.
23352348
-->
23362349

23372350
* `value` {string|Buffer|Uint8Array|integer} What to search for.
2338-
* `byteOffset` {integer} Where to begin searching in `buf`. If negative, then
2351+
* `start` {integer} Where to begin searching in `buf`. If negative, then
23392352
offset is calculated from the end of `buf`. **Default:**
23402353
`buf.length - 1`.
2354+
* `end` {integer} Where to stop searching in `buf` (exclusive). **Default:**
2355+
`buf.length`.
23412356
* `encoding` {string} If `value` is a string, this is the encoding used to
23422357
determine the binary representation of the string that will be searched for in
23432358
`buf`. **Default:** `'utf8'`.
Collapse file

‎lib/buffer.js‎

Copy file name to clipboardExpand all lines: lib/buffer.js
+53-26Lines changed: 53 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -714,83 +714,91 @@ const encodingOps = {
714714
byteLength: byteLengthUtf8,
715715
write: utf8Write,
716716
slice: utf8Slice,
717-
indexOf: (buf, val, byteOffset, dir) =>
718-
indexOfString(buf, val, byteOffset, encodingsMap.utf8, dir),
717+
indexOf: (buf, val, byteOffset, dir, end) =>
718+
indexOfString(buf, val, byteOffset, encodingsMap.utf8, dir, end),
719719
},
720720
ucs2: {
721721
encoding: 'ucs2',
722722
encodingVal: encodingsMap.utf16le,
723723
byteLength: (string) => string.length * 2,
724724
write: ucs2Write,
725725
slice: ucs2Slice,
726-
indexOf: (buf, val, byteOffset, dir) =>
727-
indexOfString(buf, val, byteOffset, encodingsMap.utf16le, dir),
726+
indexOf: (buf, val, byteOffset, dir, end) =>
727+
indexOfString(buf, val, byteOffset, encodingsMap.utf16le, dir, end),
728728
},
729729
utf16le: {
730730
encoding: 'utf16le',
731731
encodingVal: encodingsMap.utf16le,
732732
byteLength: (string) => string.length * 2,
733733
write: ucs2Write,
734734
slice: ucs2Slice,
735-
indexOf: (buf, val, byteOffset, dir) =>
736-
indexOfString(buf, val, byteOffset, encodingsMap.utf16le, dir),
735+
indexOf: (buf, val, byteOffset, dir, end) =>
736+
indexOfString(buf, val, byteOffset, encodingsMap.utf16le, dir, end),
737737
},
738738
latin1: {
739739
encoding: 'latin1',
740740
encodingVal: encodingsMap.latin1,
741741
byteLength: (string) => string.length,
742742
write: latin1Write,
743743
slice: latin1Slice,
744-
indexOf: (buf, val, byteOffset, dir) =>
745-
indexOfString(buf, val, byteOffset, encodingsMap.latin1, dir),
744+
indexOf: (buf, val, byteOffset, dir, end) =>
745+
indexOfString(buf, val, byteOffset, encodingsMap.latin1, dir, end),
746746
},
747747
ascii: {
748748
encoding: 'ascii',
749749
encodingVal: encodingsMap.ascii,
750750
byteLength: (string) => string.length,
751751
write: asciiWrite,
752752
slice: asciiSlice,
753-
indexOf: (buf, val, byteOffset, dir) =>
754-
indexOfString(buf, val, byteOffset, encodingsMap.ascii, dir),
753+
indexOf: (buf, val, byteOffset, dir, end) =>
754+
indexOfBuffer(buf,
755+
fromStringFast(val, encodingOps.ascii),
756+
byteOffset,
757+
encodingsMap.ascii,
758+
dir,
759+
end),
755760
},
756761
base64: {
757762
encoding: 'base64',
758763
encodingVal: encodingsMap.base64,
759764
byteLength: (string) => base64ByteLength(string, string.length),
760765
write: base64Write,
761766
slice: base64Slice,
762-
indexOf: (buf, val, byteOffset, dir) =>
767+
indexOf: (buf, val, byteOffset, dir, end) =>
763768
indexOfBuffer(buf,
764769
fromStringFast(val, encodingOps.base64),
765770
byteOffset,
766771
encodingsMap.base64,
767-
dir),
772+
dir,
773+
end),
768774
},
769775
base64url: {
770776
encoding: 'base64url',
771777
encodingVal: encodingsMap.base64url,
772778
byteLength: (string) => base64ByteLength(string, string.length),
773779
write: base64urlWrite,
774780
slice: base64urlSlice,
775-
indexOf: (buf, val, byteOffset, dir) =>
781+
indexOf: (buf, val, byteOffset, dir, end) =>
776782
indexOfBuffer(buf,
777783
fromStringFast(val, encodingOps.base64url),
778784
byteOffset,
779785
encodingsMap.base64url,
780-
dir),
786+
dir,
787+
end),
781788
},
782789
hex: {
783790
encoding: 'hex',
784791
encodingVal: encodingsMap.hex,
785792
byteLength: (string) => string.length >>> 1,
786793
write: hexWrite,
787794
slice: hexSlice,
788-
indexOf: (buf, val, byteOffset, dir) =>
795+
indexOf: (buf, val, byteOffset, dir, end) =>
789796
indexOfBuffer(buf,
790797
fromStringFast(val, encodingOps.hex),
791798
byteOffset,
792799
encodingsMap.hex,
793-
dir),
800+
dir,
801+
end),
794802
},
795803
};
796804
function getEncodingOps(encoding) {
@@ -1044,9 +1052,10 @@ Buffer.prototype.compare = function compare(target,
10441052
// - buffer - a Buffer to search
10451053
// - val - a string, Buffer, or number
10461054
// - byteOffset - an index into `buffer`; will be clamped to an int32
1055+
// - end - absolute exclusive end of the search range
10471056
// - encoding - an optional encoding, relevant if val is a string
10481057
// - dir - true for indexOf, false for lastIndexOf
1049-
function bidirectionalIndexOf(buffer, val, byteOffset, encoding, dir) {
1058+
function bidirectionalIndexOf(buffer, val, byteOffset, end, encoding, dir) {
10501059
validateBuffer(buffer);
10511060

10521061
if (typeof byteOffset === 'string') {
@@ -1066,7 +1075,7 @@ function bidirectionalIndexOf(buffer, val, byteOffset, encoding, dir) {
10661075
dir = !!dir; // Cast to bool.
10671076

10681077
if (typeof val === 'number')
1069-
return indexOfNumber(buffer, val >>> 0, byteOffset, dir);
1078+
return indexOfNumber(buffer, val >>> 0, byteOffset, dir, end);
10701079

10711080
let ops;
10721081
if (encoding === undefined)
@@ -1077,30 +1086,48 @@ function bidirectionalIndexOf(buffer, val, byteOffset, encoding, dir) {
10771086
if (typeof val === 'string') {
10781087
if (ops === undefined)
10791088
throw new ERR_UNKNOWN_ENCODING(encoding);
1080-
return ops.indexOf(buffer, val, byteOffset, dir);
1089+
return ops.indexOf(buffer, val, byteOffset, dir, end);
10811090
}
10821091

10831092
if (isUint8Array(val)) {
10841093
const encodingVal =
10851094
(ops === undefined ? encodingsMap.utf8 : ops.encodingVal);
1086-
return indexOfBuffer(buffer, val, byteOffset, encodingVal, dir);
1095+
return indexOfBuffer(buffer, val, byteOffset, encodingVal, dir, end);
10871096
}
10881097

10891098
throw new ERR_INVALID_ARG_TYPE(
10901099
'value', ['number', 'string', 'Buffer', 'Uint8Array'], val,
10911100
);
10921101
}
10931102

1094-
Buffer.prototype.indexOf = function indexOf(val, byteOffset, encoding) {
1095-
return bidirectionalIndexOf(this, val, byteOffset, encoding, true);
1103+
Buffer.prototype.indexOf = function indexOf(val, offset, end, encoding) {
1104+
if (typeof end === 'string') {
1105+
encoding = end;
1106+
end = this.length;
1107+
} else if (end === undefined) {
1108+
end = this.length;
1109+
}
1110+
return bidirectionalIndexOf(this, val, offset, end, encoding, true);
10961111
};
10971112

1098-
Buffer.prototype.lastIndexOf = function lastIndexOf(val, byteOffset, encoding) {
1099-
return bidirectionalIndexOf(this, val, byteOffset, encoding, false);
1113+
Buffer.prototype.lastIndexOf = function lastIndexOf(val, offset, end, encoding) {
1114+
if (typeof end === 'string') {
1115+
encoding = end;
1116+
end = this.length;
1117+
} else if (end === undefined) {
1118+
end = this.length;
1119+
}
1120+
return bidirectionalIndexOf(this, val, offset, end, encoding, false);
11001121
};
11011122

1102-
Buffer.prototype.includes = function includes(val, byteOffset, encoding) {
1103-
return bidirectionalIndexOf(this, val, byteOffset, encoding, true) !== -1;
1123+
Buffer.prototype.includes = function includes(val, offset, end, encoding) {
1124+
if (typeof end === 'string') {
1125+
encoding = end;
1126+
end = this.length;
1127+
} else if (end === undefined) {
1128+
end = this.length;
1129+
}
1130+
return bidirectionalIndexOf(this, val, offset, end, encoding, true) !== -1;
11041131
};
11051132

11061133
// Usage:

0 commit comments

Comments
0 (0)
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.