variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix some TSDoc comments

Browse source
This commit is contained in:
Andrew Prifer 2022-02-15 22:59:34 +01:00
parent d0ce9f7046
commit b643739ec7
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/dataverse/src/Box.ts
View file

@ -74,7 +74,7 @@ export default class Box<V> implements IBox<V> {
* Note: usages of `get()` aren't tracked, they are only for retrieving the value. To track changes, you need to * Note: usages of `get()` aren't tracked, they are only for retrieving the value. To track changes, you need to
* create a derivation. * create a derivation.
* *
* @see derivation * @see Box.derivation
*/ */
get() { get() {
return this._value return this._value

6
packages/dataverse/src/derivations/IDerivation.ts
View file

@ -83,11 +83,13 @@ export interface IDerivation<V> {
* by `flatMap` takes the value of that derivation. * by `flatMap` takes the value of that derivation.
* *
* @example * @example
* // Simply using `map()` here would return the inner derivation when we call `getValue()` * ```ts
* // Simply using map() here would return the inner derivation when we call getValue()
* new Box(3).derivation.map((value) => new Box(value).derivation).getValue() * new Box(3).derivation.map((value) => new Box(value).derivation).getValue()
* *
* // Using `flatMap()` eliminates the inner derivation * // Using flatMap() eliminates the inner derivation
* new Box(3).derivation.flatMap((value) => new Box(value).derivation).getValue() * new Box(3).derivation.flatMap((value) => new Box(value).derivation).getValue()
* ```
* *
* @param fn The mapping function to use. Note: it accepts a plain value, not a derivation. * @param fn The mapping function to use. Note: it accepts a plain value, not a derivation.
*/ */