Skip to content

[node] buffer: allow ArrayBuffer | string to be passed to Buffer.from #72097

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 7 commits into from
Apr 25, 2025
Merged

[node] buffer: allow ArrayBuffer | string to be passed to Buffer.from #72097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c2a3a5b
[node] buffer: allow `ArrayBuffer | string` to be passed to `Buffer.f…
sapphi-red Mar 3, 2025
fbf4143
chore: format
sapphi-red Mar 3, 2025
b1967c7
fix: fix the case I wanted to
sapphi-red Mar 3, 2025
e079993
refactor: update signature
sapphi-red Mar 5, 2025
35c26b3
chore: remove doc comment
sapphi-red Mar 5, 2025
3620eae
fix: add to ts5.6 dir
sapphi-red Mar 5, 2025
6668d64
chore: format
sapphi-red Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions types/node/buffer.buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ declare module "buffer" {
* @param encoding The encoding of `string`. **Default:** `'utf8'`.
*/
from(string: WithImplicitCoercion<string>, encoding?: BufferEncoding): Buffer<ArrayBuffer>;
from(arrayOrString: WithImplicitCoercion<ArrayLike<number> | string>): Buffer<ArrayBuffer>;
/**
* Creates a new Buffer using the passed {data}
* @param values to create a new Buffer
Expand Down
11 changes: 11 additions & 0 deletions types/node/test/buffer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,17 @@ const result2 = Buffer.concat([utf8Buffer, base64Buffer] as readonly Uint8Array[
Buffer.from({} as { [Symbol.toPrimitive](): number });
}

// ArrayLike or string
{
const arrayOrString = "foo" as number[] | string;
// $ExpectType Buffer || Buffer<ArrayBuffer>
Buffer.from(arrayOrString);

const typedArrayOrString = "foo" as Uint8Array<ArrayBuffer> | string;
// $ExpectType Buffer || Buffer<ArrayBuffer>
Buffer.from(typedArrayOrString);
}

// @ts-expect-error
Buffer.from({});
// @ts-expect-error
Expand Down
1 change: 1 addition & 0 deletions types/node/ts5.6/buffer.buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ declare module "buffer" {
* @param encoding The encoding of `string`. **Default:** `'utf8'`.
*/
from(string: WithImplicitCoercion<string>, encoding?: BufferEncoding): Buffer;
from(arrayOrString: WithImplicitCoercion<ArrayLike<number> | string>): Buffer;
/**
* Creates a new Buffer using the passed {data}
* @param values to create a new Buffer
Expand Down
1 change: 1 addition & 0 deletions types/node/v18/buffer.buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ declare module "buffer" {
* @param encoding The encoding of `string`. **Default:** `'utf8'`.
*/
from(string: WithImplicitCoercion<string>, encoding?: BufferEncoding): Buffer<ArrayBuffer>;
from(arrayOrString: WithImplicitCoercion<ArrayLike<number> | string>): Buffer<ArrayBuffer>;
/**
* Creates a new Buffer using the passed {data}
* @param values to create a new Buffer
Expand Down
11 changes: 11 additions & 0 deletions types/node/v18/test/buffer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,17 @@ const result2 = Buffer.concat([utf8Buffer, base64Buffer] as readonly Uint8Array[
Buffer.from({} as { [Symbol.toPrimitive](): number });
}

// ArrayLike or string
{
const arrayOrString = "foo" as number[] | string;
// $ExpectType Buffer || Buffer<ArrayBuffer>
Buffer.from(arrayOrString);

const typedArrayOrString = "foo" as Uint8Array<ArrayBuffer> | string;
// $ExpectType Buffer || Buffer<ArrayBuffer>
Buffer.from(typedArrayOrString);
}

// @ts-expect-error
Buffer.from({});
// @ts-expect-error
Expand Down
1 change: 1 addition & 0 deletions types/node/v18/ts5.6/buffer.buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ declare module "buffer" {
* @param encoding The encoding of `string`. **Default:** `'utf8'`.
*/
from(string: WithImplicitCoercion<string>, encoding?: BufferEncoding): Buffer;
from(arrayOrString: WithImplicitCoercion<ArrayLike<number> | string>): Buffer;
/**
* Creates a new Buffer using the passed {data}
* @param values to create a new Buffer
Expand Down
1 change: 1 addition & 0 deletions types/node/v20/buffer.buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ declare module "buffer" {
* @param encoding The encoding of `string`. **Default:** `'utf8'`.
*/
from(string: WithImplicitCoercion<string>, encoding?: BufferEncoding): Buffer<ArrayBuffer>;
from(arrayOrString: WithImplicitCoercion<ArrayLike<number> | string>): Buffer<ArrayBuffer>;
/**
* Creates a new Buffer using the passed {data}
* @param values to create a new Buffer
Expand Down
11 changes: 11 additions & 0 deletions types/node/v20/test/buffer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,17 @@ const result2 = Buffer.concat([utf8Buffer, base64Buffer] as readonly Uint8Array[
Buffer.from({} as { [Symbol.toPrimitive](): number });
}

// ArrayLike or string
{
const arrayOrString = "foo" as number[] | string;
// $ExpectType Buffer || Buffer<ArrayBuffer>
Buffer.from(arrayOrString);

const typedArrayOrString = "foo" as Uint8Array<ArrayBuffer> | string;
// $ExpectType Buffer || Buffer<ArrayBuffer>
Buffer.from(typedArrayOrString);
}

// @ts-expect-error
Buffer.from({});
// @ts-expect-error
Expand Down
1 change: 1 addition & 0 deletions types/node/v20/ts5.6/buffer.buffer.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ declare module "buffer" {
* @param encoding The encoding of `string`. **Default:** `'utf8'`.
*/
from(string: WithImplicitCoercion<string>, encoding?: BufferEncoding): Buffer;
from(arrayOrString: WithImplicitCoercion<ArrayLike<number> | string>): Buffer;
/**
* Creates a new Buffer using the passed {data}
* @param values to create a new Buffer
Expand Down