Skip to content

Commit 8b5b3c0

Browse files
vitokevitoke
authored
Merge pull request #98 from rimbu-org/fix/fix-modify-ifexists-doc-examples
docs: fix documentation examples for `.modifyAt({ ifExists })`
2 parents fc31713 + 3faa6ad commit 8b5b3c0

File tree

6 files changed

+30
-30
lines changed

6 files changed

+30
-30
lines changed

‎deno_dist/collection-types/map-custom/interface/index.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -387,11 +387,11 @@ export interface RMapBase<K, V, Tp extends RMapBase.Types = RMapBase.Types>
387387
* // => [[1, 'a'], [2, 'b'], [3, 'c']]
388388
* m.modifyAt(3, { ifNew: (none) => 1 < 2 ? none : 'c' }).toArray()
389389
* // => [[1, 'a'], [2, 'b']]
390-
* m.modifyAt(2, { ifExists: 'c' }).toArray()
390+
* m.modifyAt(2, { ifExists: () => 'c' }).toArray()
391391
* // => [[1, 'a'], [2, 'c']]
392-
* m.modifyAt(2, { ifExists: v => v + 'z' }).toArray()
392+
* m.modifyAt(2, { ifExists: (v) => v + 'z' }).toArray()
393393
* // => [[1, 'a'], [2, 'bz']]
394-
* m.modifyAt(2, { ifExists: (v, remove) => v.length > 5 ? v : remove }).toArray()
394+
* m.modifyAt(2, { ifExists: (v, remove) => v === 'a' ? v : remove }).toArray()
395395
* // => [[1, 'a']]
396396
* ```
397397
*/
@@ -882,11 +882,11 @@ export namespace RMapBase {
882882
* // => true
883883
* m.modifyAt(3, { ifNew: (none) => 1 < 2 ? none : 'c' })
884884
* // => false
885-
* m.modifyAt(2, { ifExists: 'c' })
885+
* m.modifyAt(2, { ifExists: () => 'c' })
886886
* // => true
887-
* m.modifyAt(1, { ifExists: v => v + 'z' })
887+
* m.modifyAt(1, { ifExists: (v) => v + 'z' })
888888
* // => true
889-
* m.modifyAt(2, { ifExists: (v, remove) => v.length > 5 ? v : remove })
889+
* m.modifyAt(2, { ifExists: (v, remove) => v === 'a' ? v : remove })
890890
* // => true
891891
* ```
892892
*/

‎deno_dist/graph/custom/valued/interface/generic/valued-graph-base.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ export interface ValuedGraphBase<
7474
* // => [[1, 2, 'a'], [2, 3, 'b'], [3, 4, 'c']]
7575
* g.modifyAt(3, 4, { ifNew: (none) => 1 < 2 ? none : 'c' }).toArray()
7676
* // => [[1, 2, 'a'], [2, 3, 'b']]
77-
* g.modifyAt(1, 2, { ifExists: 'c' }).toArray()
77+
* g.modifyAt(1, 2, { ifExists: () => 'c' }).toArray()
7878
* // => [[1, 2, 'c'], [2, 3, 'b']]
79-
* g.modifyAt(1, 2, { ifExists: v => v + 'z' }).toArray()
79+
* g.modifyAt(1, 2, { ifExists: (v) => v + 'z' }).toArray()
8080
* // => [[1, 2, 'az'], [2, 3, 'b']]
81-
* g.modifyAt(2, 3, { ifExists: (v, remove) => v.length > 5 ? v : remove }).toArray()
81+
* g.modifyAt(2, 3, { ifExists: (v, remove) => v === 'a' ? v : remove }).toArray()
8282
* // => [[1, 2, 'a']]
8383
* ```
8484
*/
@@ -365,9 +365,9 @@ export namespace ValuedGraphBase {
365365
* b.modifyAt(3, 4, { ifNew: 'c' }) // => true
366366
* g.modifyAt(4, 5, { ifNew: (none) => 1 < 2 ? none : 'c' }) // => false
367367
* g.modifyAt(1, 2, { ifNew: 'a' }) // => false
368-
* g.modifyAt(1, 2, { ifExists: 'c' }) // => false
369-
* g.modifyAt(1, 2, { ifExists: v => v + 'z' }) // => true
370-
* g.modifyAt(2, 3, { ifExists: (v, remove) => v.length > 5 ? v : remove })
368+
* g.modifyAt(1, 2, { ifExists: () => 'c' }) // => false
369+
* g.modifyAt(1, 2, { ifExists: (v) => v + 'z' }) // => true
370+
* g.modifyAt(2, 3, { ifExists: (v, remove) => v === 'a' ? v : remove })
371371
* // => true
372372
* ```
373373
*/

‎deno_dist/multimap/custom/interface/base.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -463,11 +463,11 @@ export interface MultiMapBase<
463463
* // => [[1, 'a'], [2, 'b'], [3, 'c'], [3, 'd']]
464464
* m.modifyAt(3, { ifNew: () => 1 < 2 ? [] : ['c'] }).toArray()
465465
* // => [[1, 'a'], [2, 'b']]
466-
* m.modifyAt(2, { ifExists: ['c'] }).toArray()
466+
* m.modifyAt(2, { ifExists: () => ['c'] }).toArray()
467467
* // => [[1, 'a'], [2, 'c']]
468-
* m.modifyAt(2, { ifExists: v => v.add('d') }).toArray()
468+
* m.modifyAt(2, { ifExists: (v) => v.add('d') }).toArray()
469469
* // => [[1, 'a'], [2, 'c'], [2, 'd']]
470-
* m.modifyAt(2, { ifExists: (v) => v.length > 3 ? v : [] }).toArray()
470+
* m.modifyAt(2, { ifExists: (v) => v.has('a') ? v : [] }).toArray()
471471
* // => [[1, 'a']]
472472
* ```
473473
*/

‎packages/collection-types/src/map-custom/interface/index.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -387,11 +387,11 @@ export interface RMapBase<K, V, Tp extends RMapBase.Types = RMapBase.Types>
387387
* // => [[1, 'a'], [2, 'b'], [3, 'c']]
388388
* m.modifyAt(3, { ifNew: (none) => 1 < 2 ? none : 'c' }).toArray()
389389
* // => [[1, 'a'], [2, 'b']]
390-
* m.modifyAt(2, { ifExists: 'c' }).toArray()
390+
* m.modifyAt(2, { ifExists: () => 'c' }).toArray()
391391
* // => [[1, 'a'], [2, 'c']]
392-
* m.modifyAt(2, { ifExists: v => v + 'z' }).toArray()
392+
* m.modifyAt(2, { ifExists: (v) => v + 'z' }).toArray()
393393
* // => [[1, 'a'], [2, 'bz']]
394-
* m.modifyAt(2, { ifExists: (v, remove) => v.length > 5 ? v : remove }).toArray()
394+
* m.modifyAt(2, { ifExists: (v, remove) => v === 'a' ? v : remove }).toArray()
395395
* // => [[1, 'a']]
396396
* ```
397397
*/
@@ -882,11 +882,11 @@ export namespace RMapBase {
882882
* // => true
883883
* m.modifyAt(3, { ifNew: (none) => 1 < 2 ? none : 'c' })
884884
* // => false
885-
* m.modifyAt(2, { ifExists: 'c' })
885+
* m.modifyAt(2, { ifExists: () => 'c' })
886886
* // => true
887-
* m.modifyAt(1, { ifExists: v => v + 'z' })
887+
* m.modifyAt(1, { ifExists: (v) => v + 'z' })
888888
* // => true
889-
* m.modifyAt(2, { ifExists: (v, remove) => v.length > 5 ? v : remove })
889+
* m.modifyAt(2, { ifExists: (v, remove) => v === 'a' ? v : remove })
890890
* // => true
891891
* ```
892892
*/

‎packages/graph/src/custom/valued/interface/generic/valued-graph-base.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ export interface ValuedGraphBase<
7474
* // => [[1, 2, 'a'], [2, 3, 'b'], [3, 4, 'c']]
7575
* g.modifyAt(3, 4, { ifNew: (none) => 1 < 2 ? none : 'c' }).toArray()
7676
* // => [[1, 2, 'a'], [2, 3, 'b']]
77-
* g.modifyAt(1, 2, { ifExists: 'c' }).toArray()
77+
* g.modifyAt(1, 2, { ifExists: () => 'c' }).toArray()
7878
* // => [[1, 2, 'c'], [2, 3, 'b']]
79-
* g.modifyAt(1, 2, { ifExists: v => v + 'z' }).toArray()
79+
* g.modifyAt(1, 2, { ifExists: (v) => v + 'z' }).toArray()
8080
* // => [[1, 2, 'az'], [2, 3, 'b']]
81-
* g.modifyAt(2, 3, { ifExists: (v, remove) => v.length > 5 ? v : remove }).toArray()
81+
* g.modifyAt(2, 3, { ifExists: (v, remove) => v === 'a' ? v : remove }).toArray()
8282
* // => [[1, 2, 'a']]
8383
* ```
8484
*/
@@ -365,9 +365,9 @@ export namespace ValuedGraphBase {
365365
* b.modifyAt(3, 4, { ifNew: 'c' }) // => true
366366
* g.modifyAt(4, 5, { ifNew: (none) => 1 < 2 ? none : 'c' }) // => false
367367
* g.modifyAt(1, 2, { ifNew: 'a' }) // => false
368-
* g.modifyAt(1, 2, { ifExists: 'c' }) // => false
369-
* g.modifyAt(1, 2, { ifExists: v => v + 'z' }) // => true
370-
* g.modifyAt(2, 3, { ifExists: (v, remove) => v.length > 5 ? v : remove })
368+
* g.modifyAt(1, 2, { ifExists: () => 'c' }) // => false
369+
* g.modifyAt(1, 2, { ifExists: (v) => v + 'z' }) // => true
370+
* g.modifyAt(2, 3, { ifExists: (v, remove) => v === 'a' ? v : remove })
371371
* // => true
372372
* ```
373373
*/

‎packages/multimap/src/custom/interface/base.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -463,11 +463,11 @@ export interface MultiMapBase<
463463
* // => [[1, 'a'], [2, 'b'], [3, 'c'], [3, 'd']]
464464
* m.modifyAt(3, { ifNew: () => 1 < 2 ? [] : ['c'] }).toArray()
465465
* // => [[1, 'a'], [2, 'b']]
466-
* m.modifyAt(2, { ifExists: ['c'] }).toArray()
466+
* m.modifyAt(2, { ifExists: () => ['c'] }).toArray()
467467
* // => [[1, 'a'], [2, 'c']]
468-
* m.modifyAt(2, { ifExists: v => v.add('d') }).toArray()
468+
* m.modifyAt(2, { ifExists: (v) => v.add('d') }).toArray()
469469
* // => [[1, 'a'], [2, 'c'], [2, 'd']]
470-
* m.modifyAt(2, { ifExists: (v) => v.length > 3 ? v : [] }).toArray()
470+
* m.modifyAt(2, { ifExists: (v) => v.has('a') ? v : [] }).toArray()
471471
* // => [[1, 'a']]
472472
* ```
473473
*/

0 commit comments

Comments
 (0)