Update WebSocket.binaryType description with the new behavior #1690
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/sources/next/javascript-api/k6-experimental/websockets/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/websockets/blob/_index.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/websockets/blob/_index.md
Outdated
Show resolved
Hide resolved
5 tasks
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
joanlopez
commented
Aug 13, 2024
Comment on lines
+21
to
+25
| | Blob.arrayBuffer() | Returns a `Promise` that resolves with the contents of the blob as binary data contained in an `ArrayBuffer`. | | ||
| | Blob.bytes() | Returns a `Promise` that resolves with a `Uint8Array` containing the contents of the blob as an array of bytes. | | ||
| | Blob.slice() | Returns a new `Blob` object which contains data from a subset of the blob on which it's called. | | ||
| | Blob.stream() | Returns a [ReadableStream](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/streams/readablestream) which upon reading returns the data contained within the `Blob`. | | ||
| | Blob.text() | Returns a `Promise` that resolves with a string containing the contents of the blob, interpreted as `UTF-8`. | |
There was a problem hiding this comment.
Do you (@mstoykov) think we need specific pages for these methods, as we have for WebSocket methods? 🤔
I'm wondering whether specific examples of each method are really useful. Maybe just slice() which is the only one that can have multiple variants? Or just point to the MDN Web Docs?
There was a problem hiding this comment.
I think that we can do that in a future iteration. Maybe when Blob isn't in this module but globally available.
…ndex.md Co-authored-by: Heitor Tashiro Sergent <[email protected]>
mstoykov
approved these changes
Aug 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
It updates the description of
WebSocket.binaryTypeaccording to the recent changes.Checklist
npm startcommand locally and verified that the changes look good.docs/sources/nextfolder of the documentation.docs/sources/v{most_recent_release}folder of the documentation.docs/sources/nextfolder of the documentation.Related PR(s)/Issue(s)