Skip to content

Commit b15897f

Browse files
committed
Clarify browser return value is opaque
1 parent cbdd113 commit b15897f

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

src/content/reference/react-dom/browser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ During server rendering, `use(browser())` stops rendering the component and leav
5151
5252
#### Returns {/*returns*/}
5353
54-
`browser` returns a value that you can pass to `use` in a component or use as the reason when [aborting a server render](#aborting-pending-server-rendering-for-the-browser). In the browser, passing this value to `use` returns `undefined`.
54+
`browser` returns an opaque value that you can pass to `use` in a component or use as the reason when [aborting a server render](#aborting-pending-server-rendering-for-the-browser). In the browser, passing this value to `use` returns `undefined`.
5555
5656
#### Caveats {/*caveats*/}
5757

src/content/reference/react/apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can pass these types of resources to [`use`](/reference/react/use):
2929

3030
* A [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) to read its resolved value.
3131
* A [context](/learn/passing-data-deeply-with-context) to read its value.
32-
* <CanaryBadge /> The value returned by [`browser`](/reference/react-dom/browser) to mark a component as browser-only during server rendering.
32+
* <CanaryBadge /> An opaque value returned by [`browser`](/reference/react-dom/browser) to mark a component as browser-only during server rendering.
3333

3434
```js
3535
function MessageComponent({ messagePromise }) {

src/content/reference/react/use.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: use
44

55
<Intro>
66

7-
`use` is a React API that lets you read the value of a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) or [context](/learn/passing-data-deeply-with-context). You can also pass `use` the value returned by [`browser`](/reference/react-dom/browser) to mark a component as browser-only during server rendering.
7+
`use` is a React API that lets you read the value of a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) or [context](/learn/passing-data-deeply-with-context). You can also call `use` with the opaque value returned by [`browser`](/reference/react-dom/browser) to mark a component as browser-only during server rendering.
88

99
```js
1010
const value = use(resource);
@@ -100,7 +100,7 @@ During server rendering, the component calling `use(browser())` suspends and Rea
100100
101101
#### Parameters {/*browser-parameters*/}
102102
103-
* `browserValue`: The value returned by [`browser`](/reference/react-dom/browser).
103+
* `browserValue`: The opaque value returned by [`browser`](/reference/react-dom/browser).
104104
105105
#### Returns {/*browser-returns*/}
106106

0 commit comments

Comments
 (0)