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

Jump to bottom

[Workers] Add Notes about Type Expections about Worker's Socket API #9118

Merged
merged 3 commits into from
Oct 11, 2023
Merged

[Workers] Add Notes about Type Expections about Worker's Socket API #9118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db1a8d7
Add Notes about Type Expections about Worker's Socket API
xiaokangwang May 26, 2023
b4964ed
Update content/workers/runtime-apis/tcp-sockets.md
irvinebroque Oct 9, 2023
fdae5ca
Apply suggestions from code review
irvinebroque Oct 10, 2023
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
1 change: 1 addition & 0 deletions content/workers/runtime-apis/streams/writablestreamdefaultwriter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ await someResponse.body.pipeTo(writable);
- {{<code>}}write(chunk{{<param-type>}}any{{</param-type>}}){{</code>}} : {{<type>}}Promise\<void>{{</type>}}

- Writes a chunk of data to the writer and returns a promise that resolves if the operation succeeds.
- The underlying stream may accept fewer kinds of type than `any`, it will throw an exception when encountering an unexpected type.

{{</definitions>}}

Expand Down
1 change: 1 addition & 0 deletions content/workers/runtime-apis/tcp-sockets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ export default {

- {{<code>}}writable{{</code>}} : {{<type-link href="/workers/runtime-apis/streams/writablestream/">}}WritableStream{{</type-link>}}
- Returns the writable side of the TCP socket.
- The `WritableStream` returned only accepts chunks of `Uint8Array` or its views.

- `closed` {{<type>}}`Promise<void>`{{</type>}}
- This promise is resolved when the socket is closed and is rejected if the socket encounters an error.
Expand Down