Add more documentation for Godoc as well as renaming the variables to match with io's

This commit is contained in:
Tracker-Friendly 2024-10-25 20:22:15 +01:00
parent 6f6415241e
commit 76f95f834c
1 changed files with 9 additions and 4 deletions

13
main.go
View File

@ -18,8 +18,8 @@ type ReadableStream struct {
// Read reads up to len(p) bytes into p. It returns the number of bytes read (0 <= n <= len(p)) and any error encountered. // Read reads up to len(p) bytes into p. It returns the number of bytes read (0 <= n <= len(p)) and any error encountered.
// This implementation of Read does not use scratch space if n < len(p). If some data is available but not len(p) bytes, // This implementation of Read does not use scratch space if n < len(p). If some data is available but not len(p) bytes,
// Read conventionally returns what is available instead of waiting for more. Note: Read will block until data is available, // Read conventionally returns what is available instead of waiting for more. Note: Read will block until data is available,
// meaning in a WASM environment, you **must** use a goroutine to call Read. // meaning in a WASM environment, you must use a goroutine to call Read.
func (r *ReadableStream) Read(inputBytes []byte) (n int, err error) { func (r *ReadableStream) Read(p []byte) (n int, err error) {
defer func() { defer func() {
recovered := recover() recovered := recover()
if recovered != nil { if recovered != nil {
@ -33,13 +33,13 @@ func (r *ReadableStream) Read(inputBytes []byte) (n int, err error) {
reader := r.stream.Call("getReader", map[string]interface{}{"mode": "byob"}) reader := r.stream.Call("getReader", map[string]interface{}{"mode": "byob"})
resultBuffer := js.Global().Get("Uint8Array").New(len(inputBytes)) resultBuffer := js.Global().Get("Uint8Array").New(len(p))
readResult := reader.Call("read", resultBuffer) readResult := reader.Call("read", resultBuffer)
readResult.Call("then", js.FuncOf(func(this js.Value, args []js.Value) interface{} { readResult.Call("then", js.FuncOf(func(this js.Value, args []js.Value) interface{} {
defer waitGroup.Done() defer waitGroup.Done()
data := args[0].Get("value") data := args[0].Get("value")
js.CopyBytesToGo(inputBytes, data) js.CopyBytesToGo(p, data)
if args[0].Get("done").Bool() { if args[0].Get("done").Bool() {
err = io.EOF err = io.EOF
} }
@ -82,11 +82,15 @@ func NewReadableStream(stream js.Value) *ReadableStream {
return &ReadableStream{stream: stream} return &ReadableStream{stream: stream}
} }
// WritableStream implements io.WriteCloser for a JavaScript WritableStream.
type WritableStream struct { type WritableStream struct {
stream js.Value stream js.Value
lock sync.Mutex lock sync.Mutex
} }
// Write writes len(p) bytes from p to the underlying data stream. It returns the number of bytes written from p (0 <= n <= len(p))
// and any error encountered that caused the write to stop early. Write must return a non-nil error if it returns n < len(p).
// Write must not modify the slice data, even temporarily.
func (w *WritableStream) Write(p []byte) (n int, err error) { func (w *WritableStream) Write(p []byte) (n int, err error) {
defer func() { defer func() {
recovered := recover() recovered := recover()
@ -131,6 +135,7 @@ func (w *WritableStream) Write(p []byte) (n int, err error) {
return n, err return n, err
} }
// Close closes the WritableStream. If the stream is already closed, Close does nothing.
func (w *WritableStream) Close() (err error) { func (w *WritableStream) Close() (err error) {
defer func() { defer func() {
recovered := recover() recovered := recover()