Skip to content
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

[node] Add structuredClone global to node #59434

Merged
merged 4 commits into from
Apr 26, 2022
Merged

[node] Add structuredClone global to node #59434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a83148b
Add structuredClone to node
josh- Mar 24, 2022
efa0a4f
Change type of transfer to take readonly array of TransferListItems
josh- Mar 25, 2022
e1ee5cf
Merge branch 'master' of github.com:DefinitelyTyped/DefinitelyTyped i…
josh- Apr 24, 2022
12cc02a
Update format of @since tag
josh- Apr 26, 2022
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
10 changes: 10 additions & 0 deletions types/node/globals.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,16 @@ interface BigInt64Array extends RelativeIndexable<bigint> {}
interface BigUint64Array extends RelativeIndexable<bigint> {}
//#endregion ArrayLike.at() end

/**
* @since v17.0.0
*
* Creates a deep clone of an object.
*/
declare function structuredClone<T>(
value: T,
transfer?: { transfer: ReadonlyArray<import('worker_threads').TransferListItem> },
): T;

/*----------------------------------------------*
* *
* GLOBAL INTERFACES *
Expand Down
11 changes: 11 additions & 0 deletions types/node/test/globals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,14 @@ declare var RANDOM_GLOBAL_VARIABLE: true;
gc();
}
}

// structuredClone
{
structuredClone(123); // $ExpectType 123
structuredClone('hello'); // $ExpectType "hello"
structuredClone({ test: 123 }); // $ExpectType { test: number; }
structuredClone([{ test: 123 }]); // $ExpectType { test: number; }[]

const arrayBuffer = new ArrayBuffer(0);
structuredClone({ test: arrayBuffer }, { transfer: [arrayBuffer] }); // $ExpectType { test: ArrayBuffer; }
}