diff options
| author |  Samuel Rigaud <46346622+s-rigaud@users.noreply.github.com>
| 2023-09-12 21:50:05 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-09-12 18:50:05 -0700 |
| commit | 263382103f47ce6f7063ad07d34664718b4c1ea7 (patch) | |
| tree | 20b7954f6f99de6e6472bd1e4a05df72e9e88ae7 /docs/api | |
| parent | 8777c3f72c8aa0dfef73a52c66887c0faaf41401 (diff) | |
| download | bun-263382103f47ce6f7063ad07d34664718b4c1ea7.tar.gz bun-263382103f47ce6f7063ad07d34664718b4c1ea7.tar.zst bun-263382103f47ce6f7063ad07d34664718b4c1ea7.zip | |
docs: fix typos (#5151)
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/binary-data.md | 4 | ||||
| -rw-r--r-- | docs/api/transpiler.md | 2 | ||||
| -rw-r--r-- | docs/api/utils.md | 2 | ||||
| -rw-r--r-- | docs/api/websockets.md | 2 | ||||
| -rw-r--r-- | docs/api/workers.md | 2 |
5 files changed, 6 insertions, 6 deletions
diff --git a/docs/api/binary-data.md b/docs/api/binary-data.md index a75d08309..a5fa40d9e 100644 --- a/docs/api/binary-data.md +++ b/docs/api/binary-data.md @@ -412,7 +412,7 @@ For complete documentation, refer to the [Node.js documentation](https://nodejs. `Blob` is a Web API commonly used for representing files. `Blob` was initially implemented in browsers (unlike `ArrayBuffer` which is part of JavaScript itself), but it is now supported in Node and Bun. -It isn't common to directly create `Blob` instances. More often, you'll recieve instances of `Blob` from an external source (like an `<input type="file">` element in the browser) or library. That said, it is possible to create a `Blob` from one or more string or binary "blob parts". +It isn't common to directly create `Blob` instances. More often, you'll receive instances of `Blob` from an external source (like an `<input type="file">` element in the browser) or library. That said, it is possible to create a `Blob` from one or more string or binary "blob parts". ```ts const blob = new Blob(["<html>Hello</html>"], { @@ -507,7 +507,7 @@ for await (const chunk of stream) { } ``` -For a more complete discusson of streams in Bun, see [API > Streams](/docs/api/streams). +For a more complete discussion of streams in Bun, see [API > Streams](/docs/api/streams). ## Conversion diff --git a/docs/api/transpiler.md b/docs/api/transpiler.md index 6d81a1ef9..ede4ee7cc 100644 --- a/docs/api/transpiler.md +++ b/docs/api/transpiler.md @@ -76,7 +76,7 @@ await transpiler.transform("<div>hi!</div>", "tsx"); ``` {% details summary="Nitty gritty" %} -The `.tranform()` method runs the transpiler in Bun's worker threadpool, so if you run it 100 times, it will run it across `Math.floor($cpu_count * 0.8)` threads, without blocking the main JavaScript thread. +The `.transform()` method runs the transpiler in Bun's worker threadpool, so if you run it 100 times, it will run it across `Math.floor($cpu_count * 0.8)` threads, without blocking the main JavaScript thread. If your code uses a macro, it will potentially spawn a new copy of Bun's JavaScript runtime environment in that new thread. {% /details %} diff --git a/docs/api/utils.md b/docs/api/utils.md index de2dc6994..1e18c67e1 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -204,7 +204,7 @@ Bun.ArrayBufferSink; ## `Bun.deepEquals()` -Nestedly checks if two objects are equivalent. This is used internally by `expect().toEqual()` in `bun:test`. +Recursively checks if two objects are equivalent. This is used internally by `expect().toEqual()` in `bun:test`. ```ts const foo = { a: 1, b: 2, c: { d: 3 } }; diff --git a/docs/api/websockets.md b/docs/api/websockets.md index e704419bb..7595f2c8a 100644 --- a/docs/api/websockets.md +++ b/docs/api/websockets.md @@ -87,7 +87,7 @@ ws.send(new Uint8Array([1, 2, 3])); // TypedArray | DataView ### Headers -Once the upgrade succeeds, Bun will send a `101 Switching Protocols` response per the [spec](https://developer.mozilla.org/en-US/docs/Web/HTTP/Protocol_upgrade_mechanism). Additional `headers` can be attched to this `Response` in the call to `server.upgrade()`. +Once the upgrade succeeds, Bun will send a `101 Switching Protocols` response per the [spec](https://developer.mozilla.org/en-US/docs/Web/HTTP/Protocol_upgrade_mechanism). Additional `headers` can be attached to this `Response` in the call to `server.upgrade()`. ```ts Bun.serve({ diff --git a/docs/api/workers.md b/docs/api/workers.md index 417b77148..1a4a09965 100644 --- a/docs/api/workers.md +++ b/docs/api/workers.md @@ -123,7 +123,7 @@ By default, an active `Worker` will keep the main (spawning) process alive, so a ### `worker.unref()` -To stop a running worker from keeping the process alive, call `worker.unref()`. This decouples the lifetime of the worker to the lifetime of the main process, and is equivlent to what Node.js' `worker_threads` does. +To stop a running worker from keeping the process alive, call `worker.unref()`. This decouples the lifetime of the worker to the lifetime of the main process, and is equivalent to what Node.js' `worker_threads` does. ```ts const worker = new Worker(new URL("worker.ts", import.meta.url).href); |