Add hotness details to dataverse docs (#138)

* Add hotness details to dataverse docs

* Add reference for hot observables
This commit is contained in:
Elliot 2022-04-29 13:04:21 -04:00 committed by GitHub
parent b6e0a217cd
commit 4b5f7adf21
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -110,15 +110,65 @@ setTimeout(() => {
A few notes about the example above: A few notes about the example above:
- `variableB.derivation.changesWithoutValues()` returns a tappable that we can - `variableB.derivation.changesWithoutValues()` returns a derivation / tappable that we can
tap into (observe). tap into (observe).
- The `tap()` method returns the `untap()` function which unsubscribes the observer function - The `tap()` method returns the `untap()` function which unsubscribes the observer function
- As long as `variableB` is tapped (observed) `variableB.derivation.isHot` will - As long as `variableB` is tapped (observed) `variableB.derivation.isHot` will
bet set to `true` automatically bet set to `true` automatically
What if you want to keep a derivation hot manually even if there's no tappable ## Hotness
attached to it anymore? In this case you can use the `keepHot()` method as seen As we saw above, derivations may or may not be "hot"
below: out this modified version of the previous example: (the same concept as "hot" Observables<sup>[ref](https://medium.com/codingthesmartway-com-blog/getting-started-with-rxjs-part-3-hot-and-cold-observables-4713757c9a88)</sup>). A derivation
is hot if and only if it is being tapped.
If you want to keep a derivation hot manually even if there's no tappable
attached to it anymore, you can use the `keepHot()` method. Why would you
want to keep a derivation hot? Check out this example:
<table>
<tr>
<td>
without `keepHot()` 🥶
</td>
<td>
with `keepHot()` 🥵
</td>
</tr>
<tr>
<td>
```typescript
const variableD = prism(() => {
return performance.now()
})
console.log(variableD.getValue()) // e.g. 113.5
console.log(variableD.getValue()) // e.g. 114
// Notice they give different values
```
</td>
<td>
```typescript
const variableD = prism(() => {
return performance.now()
})
variableD.keepHot()
console.log(variableD.getValue()) // e.g. 113
console.log(variableD.getValue()) // e.g. 113
// Notice they give the same value!
```
</td>
</tr>
</table>
To see a full example of `keepHot`, check out this modified version
of the example from the section above:
```typescript ```typescript
variableB.set('some new value') variableB.set('some new value')
@ -151,6 +201,8 @@ setTimeout(() => {
}, 7000) }, 7000)
``` ```
How does `keepHot` work? It's super simple, it just adds a tap to the derivation ([source](https://github.com/theatre-js/theatre/blob/aec6b2a25135e6264e7529e7d3800c4bc3badee6/packages/dataverse/src/derivations/AbstractDerivation.ts#L103-L105)).
### `map()` ### `map()`
It is also possible to create a derivation based on an existing derivation: It is also possible to create a derivation based on an existing derivation: