Skip to content

AllowSharedBufferSource definition is incorrect #61480

Closed
microsoft/TypeScript-DOM-lib-generator
#1944
@kainino0x

Description

@kainino0x

⚙ Compilation target

ESNext or any

⚙ Library

ES2024 or newer

Missing / Incorrect Definition

type AllowSharedBufferSource = ArrayBuffer | ArrayBufferView;

should be

type AllowSharedBufferSource = ArrayBuffer | SharedArrayBuffer | ArrayBufferView;

or simply

type AllowSharedBufferSource = BufferSource | SharedArrayBuffer

Sample Code

// Before lib=ES2024, this works, though it seems like it shouldn't.
const x: AllowSharedBufferSource = new SharedArrayBuffer(4);
// The reason is that SharedArrayBuffer is structurally a subtype of ArrayBuffer:
const y: ArrayBuffer = new SharedArrayBuffer(4);
// However when you switch to lib=ES2024+, it (correctly) doesn't work anymore, because
// ArrayBuffer gained some properties that SharedArrayBuffer doesn't have.

Error (playground link):

Type 'SharedArrayBuffer' is not assignable to type 'AllowSharedBufferSource'.
  Type 'SharedArrayBuffer' is missing the following properties from type 'ArrayBuffer': resizable, resize, detached, transfer, transferToFixedLength

Documentation Link

https://webidl.spec.whatwg.org/#AllowSharedBufferSource

WebIDL:

typedef (ArrayBuffer or SharedArrayBuffer or [AllowShared] ArrayBufferView) AllowSharedBufferSource;

Metadata

Metadata

Assignees

Labels

Needs InvestigationThis issue needs a team member to investigate its status.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions