Skip to content

docs: add structured clone and transferable API reference#3101

Open
bartlomieju wants to merge 1 commit intomainfrom
docs/structured-clone-blob-file
Open

docs: add structured clone and transferable API reference#3101
bartlomieju wants to merge 1 commit intomainfrom
docs/structured-clone-blob-file

Conversation

@bartlomieju
Copy link
Copy Markdown
Member

Summary

  • Adds tables documenting which Web API types are serializable (support structuredClone() / postMessage()) and which are transferable
  • Updated both the API reference page (api/web/index.md) and the runtime reference page (runtime/reference/web_platform_apis.md)
  • Motivated by the addition of Blob/File structured clone support in feat(ext/web): support structured clone for Blob and File deno#33827

Serializable types documented

Primitives, Array, Object, Map, Set, Date, RegExp, ArrayBuffer, TypedArray, DataView, Error types, Blob, File, DOMException, CryptoKey

Transferable types documented

ArrayBuffer, MessagePort, ReadableStream, WritableStream, TransformStream

Test plan

  • Verify tables render correctly on the docs site
  • Verify links resolve properly

Document which Web API types support structuredClone()/postMessage()
serialization and which support transfer, following the addition of
Blob and File structured clone support in denoland/deno#33827.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant