languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-10-14 17:40:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

[dart:js_interop] Modify some documentation around arrays/lists

Browse source 
Just some clarifications around what to expect when using these
conversion functions.

CoreLibraryReviewExempt: Documentation change.
Change-Id: I7fcd26a0fb14ac48bf80df1f9252584a730cb47f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/326687
Reviewed-by: Sigmund Cherem <sigmund@google.com>
This commit is contained in:
Srujan Gaddam 2023-09-21 21:41:39 +00:00 committed by Commit Queue
parent 042f2a1806
commit 94e4a4dfb5
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
sdk/lib/js_interop/js_interop.dart
View file

@ -212,9 +212,17 @@ extension JSPromiseToFuture on JSPromise {
external Future<JSAny?> get toDart;
}
// TODO(joshualitt): On Wasm backends List / Array conversion methods will
// copy, and on JS backends they will not. We should find a path towards
// consistent semantics.
// **WARNING**:
// Currently, the `toJS` getters on `dart:typed_data` types have inconsistent
// semantics today between dart2wasm and the JS compilers. dart2wasm copies the
// contents over, while the JS compilers passes the typed arrays by reference as
// they are JS typed arrays under the hood. Do not rely on modifications to the
// Dart type to affect the JS type.
//
// All the `toDart` getters on the JS typed arrays will introduce a wrapper
// around the JS typed array, however. So modifying the Dart type will modify
// the JS type and vice versa in that case.
/// [JSArrayBuffer] <-> [ByteBuffer]
extension JSArrayBufferToByteBuffer on JSArrayBuffer {
external ByteBuffer get toDart;
@ -317,6 +325,8 @@ extension Float64ListToJSFloat64Array on Float64List {
/// [JSArray] <-> [List]
extension JSArrayToList on JSArray {
/// Returns a list wrapper of the JS array.
///
/// Modifying the JS array will modify the returned list and vice versa.
external List<JSAny?> get toDart;
}