-
-
Notifications
You must be signed in to change notification settings - Fork 503
/
Record.ts
1804 lines (1720 loc) · 54.1 KB
/
Record.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* The `Record` module enables dealing with Typescript's `Record<K, T>`
* type in a functional way, basically treating it as a `Functor` in `T`.
*
* @since 2.0.0
*/
import {
Applicative,
Applicative1,
Applicative2,
Applicative2C,
Applicative3,
Applicative3C,
Applicative4
} from './Applicative'
import * as A from './Array'
import { Compactable1 } from './Compactable'
import { Either } from './Either'
import { Eq } from './Eq'
import { Filterable1 } from './Filterable'
import { FilterableWithIndex1, PredicateWithIndex, RefinementWithIndex } from './FilterableWithIndex'
import { Foldable as FoldableHKT, Foldable1, Foldable2, Foldable3 } from './Foldable'
import { FoldableWithIndex1 } from './FoldableWithIndex'
import { pipe } from './function'
import { flap as flap_, Functor1 } from './Functor'
import { FunctorWithIndex1 } from './FunctorWithIndex'
import { HKT, Kind, Kind2, Kind3, Kind4, URIS, URIS2, URIS3, URIS4 } from './HKT'
import * as _ from './internal'
import { Magma } from './Magma'
import { Monoid } from './Monoid'
import { Option } from './Option'
import { Ord } from './Ord'
import { Predicate } from './Predicate'
import * as RR from './ReadonlyRecord'
import { Refinement } from './Refinement'
import * as Se from './Semigroup'
import { Separated } from './Separated'
import { Show } from './Show'
import * as S from './string'
import { Traversable1 } from './Traversable'
import { TraversableWithIndex1 } from './TraversableWithIndex'
import { Unfoldable, Unfoldable1 } from './Unfoldable'
import { PipeableWilt1, PipeableWither1, wiltDefault, Witherable1, witherDefault } from './Witherable'
import Semigroup = Se.Semigroup
// -------------------------------------------------------------------------------------
// model
// -------------------------------------------------------------------------------------
/**
* Calculate the number of key/value pairs in a `Record`.
*
* @example
* import { size } from "fp-ts/Record";
*
* assert.deepStrictEqual(size({ a: true, b: 2, c: "three" }), 3);
*
* @since 2.0.0
*/
export const size: <A>(r: Record<string, A>) => number = RR.size
/**
* Test whether a `Record` is empty.
*
* @example
* import { isEmpty } from "fp-ts/Record";
*
* assert.deepStrictEqual(isEmpty({}), true);
* assert.deepStrictEqual(isEmpty({ a: 3 }), false);
*
* @since 2.0.0
*/
export const isEmpty: <A>(r: Record<string, A>) => boolean = RR.isEmpty
const keys_ =
(O: Ord<string>) =>
<K extends string>(r: Record<K, unknown>): Array<K> =>
(Object.keys(r) as any).sort(O.compare)
/**
* The keys of a `Record`, sorted alphabetically.
*
* @example
* import { keys } from "fp-ts/Record";
*
* assert.deepStrictEqual(keys({ c: 1, a: 2, b: 3 }), ["a", "b", "c"]);
*
* @since 2.0.0
*/
export const keys: <K extends string>(r: Record<K, unknown>) => Array<K> = /*#__PURE__*/ keys_(S.Ord)
/**
* Map a `Record` into an `Array`.
* It passes each key/value pair to the iterating function and collects
* the results in an array, sorted alphabetically by the original key.
*
* @example
* import { collect } from 'fp-ts/Record'
* import { Ord } from 'fp-ts/string'
*
* const f = <A>(k: string, a: A) => `${k.toUpperCase()}-${a}`;
* const x = { c: 3, a: "foo", b: false };
* assert.deepStrictEqual(
* collect(Ord)(f)(x),
* [
* "A-foo",
* "B-false",
* "C-3",
* ]
* );
*
* @since 2.0.0
*/
export function collect(O: Ord<string>): <K extends string, A, B>(f: (k: K, a: A) => B) => (r: Record<K, A>) => Array<B>
/**
* Use the overload constrained by `Ord` instead.
*
* @deprecated
*/
export function collect<K extends string, A, B>(f: (k: K, a: A) => B): (r: Record<K, A>) => Array<B>
export function collect<A, B>(
O: Ord<string> | ((k: string, a: A) => B)
):
| (<K extends string, A, B>(f: (k: K, a: A) => B) => (r: Record<K, A>) => Array<B>)
| ((r: Record<string, A>) => Array<B>) {
if (typeof O === 'function') {
return collect(S.Ord)(O)
}
const keysO = keys_(O)
return <K extends string, A, B>(f: (k: K, a: A) => B) =>
(r: Record<K, A>) => {
const out: Array<B> = []
for (const key of keysO(r)) {
out.push(f(key, r[key]))
}
return out
}
}
/**
* Get a sorted `Array` of the key/value pairs contained in a `Record`.
* Sorted alphabetically by key.
*
* @example
* import { toArray } from 'fp-ts/Record'
*
* const x = { c: 3, a: "foo", b: false };
* assert.deepStrictEqual(toArray(x), [
* ["a", "foo"],
* ["b", false],
* ["c", 3],
* ]);
*
* @category conversions
* @since 2.0.0
*/
export const toArray: <K extends string, A>(r: Record<K, A>) => Array<[K, A]> = /*#__PURE__*/ collect(S.Ord)((k, a) => [
k,
a
])
/**
* Unfolds a `Record` into a list of key/value pairs.
*
* Given an `Unfoldable` class type `U` such as `array` or `readonlyArray`,
* it uses the `unfold` function to create an instance of `U`,
* providing an iterating function that iterates over each
* key/value pair in the record sorted alphabetically by key.
*
* @example
* import { array, readonlyArray } from 'fp-ts'
* import { toUnfoldable } from 'fp-ts/Record'
*
* assert.deepStrictEqual(toUnfoldable(array)({ b: 2, a: 1 }),[ [ 'a', 1 ], [ 'b', 2 ]])
* assert.deepStrictEqual(toUnfoldable(readonlyArray)({ b: 2, a: 1 }),[ [ 'a', 1 ], [ 'b', 2 ]])
*
* @since 2.0.0
*/
export function toUnfoldable<F extends URIS>(
U: Unfoldable1<F>
): <K extends string, A>(r: Record<K, A>) => Kind<F, [K, A]>
export function toUnfoldable<F>(U: Unfoldable<F>): <K extends string, A>(r: Record<K, A>) => HKT<F, [K, A]>
export function toUnfoldable<F>(U: Unfoldable<F>): <A>(r: Record<string, A>) => HKT<F, [string, A]> {
return (r) => {
const sas = toArray(r)
const len = sas.length
return U.unfold(0, (b) => (b < len ? _.some([sas[b], b + 1]) : _.none))
}
}
/**
* Insert or replace a key/value pair in a `Record`.
*
* @example
* import { upsertAt } from 'fp-ts/Record'
*
* assert.deepStrictEqual(upsertAt("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
* assert.deepStrictEqual(upsertAt("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 });
*
* @since 2.10.0
*/
export const upsertAt: <A>(k: string, a: A) => (r: Record<string, A>) => Record<string, A> = RR.upsertAt
/**
* Test whether or not a key exists in a `Record`.
*
* Note. This function is not pipeable because is a `Refinement`.
*
* @example
* import { has } from 'fp-ts/Record'
*
* assert.deepStrictEqual(has("a", { a: 1, b: 2 }), true);
* assert.deepStrictEqual(has("c", { a: 1, b: 2 }), false);
*
* @since 2.10.0
*/
export const has: <K extends string>(k: string, r: Record<K, unknown>) => k is K = RR.has
/**
* Delete a key and value from a `Record`.
*
* @example
* import { deleteAt } from 'fp-ts/Record'
*
* assert.deepStrictEqual(deleteAt("a")({ a: 1, b: 2 }), { b: 2 });
* assert.deepStrictEqual(deleteAt("c")({ a: 1, b: 2 }), { a: 1, b: 2 });
*
* @since 2.0.0
*/
export function deleteAt<K extends string>(
k: K
): <KS extends string, A>(r: Record<KS, A>) => Record<string extends K ? string : Exclude<KS, K>, A>
export function deleteAt(k: string): <A>(r: Record<string, A>) => Record<string, A> {
return <A>(r: Record<string, A>) => {
if (!_.has.call(r, k)) {
return r
}
const out: Record<string, A> = Object.assign({}, r)
delete out[k]
return out
}
}
/**
* Replace a key/value pair in a `Record`.
*
* @returns If the specified key exists it returns an `Option` containing a new `Record`
* with the entry updated, otherwise it returns `None`
*
* @example
* import { updateAt } from 'fp-ts/Record'
* import { option } from 'fp-ts'
*
* assert.deepStrictEqual(updateAt("a", 3)({ a: 1, b: 2 }), option.some({ a: 3, b: 2 }));
* assert.deepStrictEqual(updateAt("c", 3)({ a: 1, b: 2 }), option.none);
*
* @since 2.0.0
*/
export const updateAt = <A>(k: string, a: A): (<K extends string>(r: Record<K, A>) => Option<Record<K, A>>) =>
modifyAt(k, () => a)
/**
* Applies a mapping function to one spcific key/value pair in a `Record`.
*
* @returns If the specified key exists it returns an `Option` containing a new `Record`
* with the entry updated, otherwise it returns `None`
*
* @example
* import { modifyAt } from 'fp-ts/Record'
* import { option } from 'fp-ts'
*
* assert.deepStrictEqual(modifyAt("a", (x: number) => x * 3)({ a: 1, b: 2 }), option.some({ a: 3, b: 2 }));
* assert.deepStrictEqual(modifyAt("c", (x: number) => x * 3)({ a: 1, b: 2 }), option.none);
*
* @since 2.0.0
*/
export const modifyAt =
<A>(k: string, f: (a: A) => A) =>
<K extends string>(r: Record<K, A>): Option<Record<K, A>> => {
if (!has(k, r)) {
return _.none
}
const out: Record<K, A> = Object.assign({}, r)
out[k] = f(r[k])
return _.some(out)
}
/**
* Delete a key and value from a `Record`, returning the value as well as the subsequent `Record`.
*
* @returns If the specified key exists it returns an `Option` containing a new `Record`
* with the entry removed, otherwise it returns `None`
*
* @example
* import { pop } from 'fp-ts/Record'
* import { option } from 'fp-ts'
*
* assert.deepStrictEqual(pop("a")({ a: 1, b: 2, c: 3 }), option.some([1, { b: 2, c: 3 }]));
* assert.deepStrictEqual(pop("x")({ a: 1, b: 2, c: 3 }), option.none);
*
* @since 2.0.0
*/
export function pop<K extends string>(
k: K
): <KS extends string, A>(r: Record<KS, A>) => Option<[A, Record<string extends K ? string : Exclude<KS, K>, A>]>
export function pop(k: string): <A>(r: Record<string, A>) => Option<[A, Record<string, A>]> {
const deleteAtk = deleteAt(k)
return (r) => {
const oa = lookup(k, r)
return _.isNone(oa) ? _.none : _.some([oa.value, deleteAtk(r)])
}
}
// TODO: remove non-curried overloading in v3
/**
* Test whether one `Record` contains all of the keys and values
* contained in another `Record`.
*
* @example
* import { isSubrecord } from 'fp-ts/Record'
* import { string } from 'fp-ts'
*
* assert.deepStrictEqual(
* isSubrecord(string.Eq)({ a: "foo", b: "bar", c: "baz" })({ a: "foo", b: "bar", c: "baz" }),
* true
* );
* assert.deepStrictEqual(
* isSubrecord(string.Eq)({ a: "foo", b: "bar", c: "baz" })({ a: "foo", c: "baz" }),
* true
* );
* assert.deepStrictEqual(
* isSubrecord(string.Eq)({ a: "foo", b: "bar", c: "baz" })({ a: "foo", b: "not-bar", c: "baz" }),
* false
* );
* assert.deepStrictEqual(
* isSubrecord(string.Eq)({ a: "foo", b: "bar" })({ a: "foo", b: "bar", c: "baz" }),
* false
* );
*
* @since 2.0.0
*/
export const isSubrecord: <A>(E: Eq<A>) => {
(that: Record<string, A>): (me: Record<string, A>) => boolean
(me: Record<string, A>, that: Record<string, A>): boolean
} = RR.isSubrecord
// TODO: remove non-curried overloading in v3
/**
* Lookup the value for a key in a `Record`.
*
* @returns If the specified key exists it returns an `Option` containing the value,
* otherwise it returns `None`
*
* @example
* import { lookup } from 'fp-ts/Record'
* import { option } from 'fp-ts'
*
* assert.deepStrictEqual(lookup("b")({ a: "foo", b: "bar" }), option.some("bar"));
* assert.deepStrictEqual(lookup("c")({ a: "foo", b: "bar" }), option.none);
*
* @since 2.0.0
*/
export const lookup: {
(k: string): <A>(r: Record<string, A>) => Option<A>
<A>(k: string, r: Record<string, A>): Option<A>
} = RR.lookup
/**
* Map a `Record` passing the key/value pairs to the iterating function.
*
* @example
* import { mapWithIndex } from "fp-ts/Record";
*
* const f = (k: string, n: number) => `${k.toUpperCase()}-${n}`;
* assert.deepStrictEqual(mapWithIndex(f)({ a: 3, b: 5 }), { a: "A-3", b: "B-5" });
*
* @since 2.0.0
*/
export const mapWithIndex: <K extends string, A, B>(f: (k: K, a: A) => B) => (fa: Record<K, A>) => Record<K, B> =
RR.mapWithIndex
/**
* Map a `Record` passing the values to the iterating function.
*
* @example
* import { map } from "fp-ts/Record";
*
* const f = (n: number) => `-${n}-`;
* assert.deepStrictEqual(map(f)({ a: 3, b: 5 }), { a: "-3-", b: "-5-" });
*
* @category mapping
* @since 2.0.0
*/
export const map: <A, B>(f: (a: A) => B) => <K extends string>(fa: Record<K, A>) => Record<K, B> = RR.map
/**
* Reduces a `Record` passing each key/value pair to the iterating function.
* Entries are processed in the order, sorted by key according to
* the given `Ord`.
*
* @example
* import { reduceWithIndex } from "fp-ts/Record";
* import { Ord } from "fp-ts/string";
*
* const x = { c: 3, a: "foo", b: false };
* assert.deepStrictEqual(reduceWithIndex(Ord)([] as string[], (k, b, a) => [...b, `${k}-${a}`])(x), [
* "a-foo",
* "b-false",
* "c-3",
* ]);
*
* @since 2.0.0
*/
export function reduceWithIndex(
O: Ord<string>
): <K extends string, A, B>(b: B, f: (k: K, b: B, a: A) => B) => (fa: Record<K, A>) => B
/**
* Use the overload constrained by `Ord` instead.
*
* @deprecated
*/
export function reduceWithIndex<K extends string, A, B>(b: B, f: (k: K, b: B, a: A) => B): (fa: Record<K, A>) => B
export function reduceWithIndex<A, B>(
...args: [Ord<string>] | [B, (k: string, b: B, a: A) => B]
): ((b: B, f: (k: string, b: B, a: A) => B) => (fa: Record<string, A>) => B) | ((fa: Record<string, A>) => B) {
return args.length === 1 ? RR.reduceWithIndex(args[0]) : RR.reduceWithIndex(S.Ord)(...args)
}
/**
* Map and fold a `Record`.
* Map the `Record` passing each key/value pair to the iterating function.
* Then fold the results using the provided `Monoid`.
*
* @example
* import { foldMapWithIndex } from "fp-ts/Record";
* import { Ord } from "fp-ts/string";
* import { Monoid } from "fp-ts/Monoid";
*
* const m: Monoid<string> = { empty: "", concat: (x: string, y: string) => (x ? `${x} -> ${y}` : `${y}`) };
* const f = (k:string, a: number) => `${k}-${a}`
* const x = { c: 3, a: 1, b: 2 };
* assert.deepStrictEqual(foldMapWithIndex(Ord)(m)(f)(x), "a-1 -> b-2 -> c-3");
*
* @since 2.0.0
*/
export function foldMapWithIndex(
O: Ord<string>
): <M>(M: Monoid<M>) => <K extends string, A>(f: (k: K, a: A) => M) => (fa: Record<K, A>) => M
/**
* Use the overload constrained by `Ord` instead.
*
* @deprecated
*/
export function foldMapWithIndex<M>(
M: Monoid<M>
): <K extends string, A>(f: (k: K, a: A) => M) => (fa: Record<K, A>) => M
export function foldMapWithIndex<M>(
O: Ord<string> | Monoid<M>
):
| ((M: Monoid<M>) => <A>(f: (k: string, a: A) => M) => (fa: Record<string, A>) => M)
| (<A>(f: (k: string, a: A) => M) => (fa: Record<string, A>) => M) {
return 'compare' in O ? RR.foldMapWithIndex(O) : RR.foldMapWithIndex(S.Ord)(O)
}
/**
* Same as `reduceWithIndex`, but reduce starting from the right
* (i.e. in reverse order, from the last to the first entry according to
* the given `Ord`).
*
* @example
* import { reduceRightWithIndex } from "fp-ts/Record";
* import { Ord } from "fp-ts/string";
*
* const x = { c: 3, a: "foo", b: false };
* assert.deepStrictEqual(reduceRightWithIndex(Ord)([] as string[], (k, a, b) => [...b, `${k}-${a}`])(x), [
* "c-3",
* "b-false",
* "a-foo",
* ]);
*
* @since 2.0.0
*/
export function reduceRightWithIndex(
O: Ord<string>
): <K extends string, A, B>(b: B, f: (k: K, a: A, b: B) => B) => (fa: Record<K, A>) => B
/**
* Use the overload constrained by `Ord` instead.
*
* @deprecated
*/
export function reduceRightWithIndex<K extends string, A, B>(b: B, f: (k: K, a: A, b: B) => B): (fa: Record<K, A>) => B
export function reduceRightWithIndex<A, B>(
...args: [Ord<string>] | [B, (k: string, a: A, b: B) => B]
): ((b: B, f: (k: string, a: A, b: B) => B) => (fa: Record<string, A>) => B) | ((fa: Record<string, A>) => B) {
return args.length === 1 ? RR.reduceRightWithIndex(args[0]) : RR.reduceRightWithIndex(S.Ord)(...args)
}
/**
* Create a `Record` with one key/value pair.
*
* @example
* import { singleton } from "fp-ts/Record";
*
* assert.deepStrictEqual(singleton("a", 1), { a: 1 });
*
* @since 2.0.0
*/
export const singleton: <A>(k: string, a: A) => Record<string, A> = RR.singleton
/**
* @since 2.0.0
*/
export function traverseWithIndex<F extends URIS4>(
F: Applicative4<F>
): <K extends string, S, R, E, A, B>(
f: (k: K, a: A) => Kind4<F, S, R, E, B>
) => (ta: Record<K, A>) => Kind4<F, S, R, E, Record<K, B>>
export function traverseWithIndex<F extends URIS3>(
F: Applicative3<F>
): <K extends string, R, E, A, B>(
f: (k: K, a: A) => Kind3<F, R, E, B>
) => (ta: Record<K, A>) => Kind3<F, R, E, Record<K, B>>
export function traverseWithIndex<F extends URIS3, E>(
F: Applicative3C<F, E>
): <K extends string, R, A, B>(
f: (k: K, a: A) => Kind3<F, R, E, B>
) => (ta: Record<K, A>) => Kind3<F, R, E, Record<K, B>>
export function traverseWithIndex<F extends URIS2>(
F: Applicative2<F>
): <K extends string, E, A, B>(f: (k: K, a: A) => Kind2<F, E, B>) => (ta: Record<K, A>) => Kind2<F, E, Record<K, B>>
export function traverseWithIndex<F extends URIS2, E>(
F: Applicative2C<F, E>
): <K extends string, A, B>(f: (k: K, a: A) => Kind2<F, E, B>) => (ta: Record<K, A>) => Kind2<F, E, Record<K, B>>
export function traverseWithIndex<F extends URIS>(
F: Applicative1<F>
): <K extends string, A, B>(f: (k: K, a: A) => Kind<F, B>) => (ta: Record<K, A>) => Kind<F, Record<K, B>>
export function traverseWithIndex<F>(
F: Applicative<F>
): <K extends string, A, B>(f: (k: K, a: A) => HKT<F, B>) => (ta: Record<K, A>) => HKT<F, Record<K, B>>
export function traverseWithIndex<F>(
F: Applicative<F>
): <A, B>(f: (k: string, a: A) => HKT<F, B>) => (ta: Record<string, A>) => HKT<F, Record<string, B>> {
return RR.traverseWithIndex(F)
}
/**
* @since 2.0.0
*/
export function traverse<F extends URIS4>(
F: Applicative4<F>
): <S, R, E, A, B>(
f: (a: A) => Kind4<F, S, R, E, B>
) => <K extends string>(ta: Record<K, A>) => Kind4<F, S, R, E, Record<K, B>>
export function traverse<F extends URIS3>(
F: Applicative3<F>
): <R, E, A, B>(f: (a: A) => Kind3<F, R, E, B>) => <K extends string>(ta: Record<K, A>) => Kind3<F, R, E, Record<K, B>>
export function traverse<F extends URIS3, E>(
F: Applicative3C<F, E>
): <R, A, B>(f: (a: A) => Kind3<F, R, E, B>) => <K extends string>(ta: Record<K, A>) => Kind3<F, R, E, Record<K, B>>
export function traverse<F extends URIS2>(
F: Applicative2<F>
): <E, A, B>(f: (a: A) => Kind2<F, E, B>) => <K extends string>(ta: Record<K, A>) => Kind2<F, E, Record<K, B>>
export function traverse<F extends URIS2, E>(
F: Applicative2C<F, E>
): <A, B>(f: (a: A) => Kind2<F, E, B>) => <K extends string>(ta: Record<K, A>) => Kind2<F, E, Record<K, B>>
export function traverse<F extends URIS>(
F: Applicative1<F>
): <A, B>(f: (a: A) => Kind<F, B>) => <K extends string>(ta: Record<K, A>) => Kind<F, Record<K, B>>
export function traverse<F>(
F: Applicative<F>
): <A, B>(f: (a: A) => HKT<F, B>) => <K extends string>(ta: Record<K, A>) => HKT<F, Record<K, B>>
export function traverse<F>(
F: Applicative<F>
): <A, B>(f: (a: A) => HKT<F, B>) => (ta: Record<string, A>) => HKT<F, Record<string, B>> {
return RR.traverse(F)
}
/**
* `Record` sequencing,
* i.e., take a `Record` in which elements are monads
* and return a monad of a `Record` of the base types.
* The following example for instance shows sequencing
* a `Record<string, Option<number>>`
* into an `Option<Record<string, number>>`.
*
* `sequence` in `Record` is equivalent to `sequenceS` in `Apply.ts`.
*
* @example
* import { sequence } from "fp-ts/Record";
* import { option } from "fp-ts";
* import { sequenceS } from "fp-ts/Apply";
*
* assert.deepStrictEqual(
* sequence(option.Applicative)({ a: option.some(1), b: option.some(2) }),
* option.some({ a: 1, b: 2 })
* );
* assert.deepStrictEqual(sequence(option.Applicative)({ a: option.some(1), b: option.none }), option.none);
* assert.deepStrictEqual(
* sequence(option.Applicative)({ a: option.some(1), b: option.some(2) }),
* sequenceS(option.Applicative)({ a: option.some(1), b: option.some(2) })
* );
*
* @since 2.0.0
*/
export function sequence<F extends URIS3>(
F: Applicative3<F>
): <K extends string, R, E, A>(ta: Record<K, Kind3<F, R, E, A>>) => Kind3<F, R, E, Record<K, A>>
export function sequence<F extends URIS3, E>(
F: Applicative3C<F, E>
): <K extends string, R, A>(ta: Record<K, Kind3<F, R, E, A>>) => Kind3<F, R, E, Record<K, A>>
export function sequence<F extends URIS2>(
F: Applicative2<F>
): <K extends string, E, A>(ta: Record<K, Kind2<F, E, A>>) => Kind2<F, E, Record<K, A>>
export function sequence<F extends URIS2, E>(
F: Applicative2C<F, E>
): <K extends string, A>(ta: Record<K, Kind2<F, E, A>>) => Kind2<F, E, Record<K, A>>
export function sequence<F extends URIS>(
F: Applicative1<F>
): <K extends string, A>(ta: Record<K, Kind<F, A>>) => Kind<F, Record<K, A>>
export function sequence<F>(F: Applicative<F>): <K extends string, A>(ta: Record<K, HKT<F, A>>) => HKT<F, Record<K, A>>
export function sequence<F>(F: Applicative<F>): <A>(ta: Record<string, HKT<F, A>>) => HKT<F, Record<string, A>> {
return RR.sequence(F)
}
/**
* @category filtering
* @since 2.6.5
*/
export const wither: PipeableWither1<URI> = <F>(
F: Applicative<F>
): (<A, B>(f: (a: A) => HKT<F, Option<B>>) => (fa: Record<string, A>) => HKT<F, Record<string, B>>) => {
const traverseF = traverse(F)
return (f) => (fa) => F.map(pipe(fa, traverseF(f)), compact)
}
/**
* @category filtering
* @since 2.6.5
*/
export const wilt: PipeableWilt1<URI> = <F>(
F: Applicative<F>
): (<A, B, C>(
f: (a: A) => HKT<F, Either<B, C>>
) => (fa: Record<string, A>) => HKT<F, Separated<Record<string, B>, Record<string, C>>>) => {
const traverseF = traverse(F)
return (f) => (fa) => F.map(pipe(fa, traverseF(f)), separate)
}
/**
* Maps a `Record` with a function returning an `Either` and
* partitions the resulting `Record` into `Left`s and `Right`s.
*
* @example
* import { partitionMapWithIndex } from "fp-ts/Record"
* import { either } from "fp-ts"
*
* const f = (key: string, a: number) =>
* a >= 0 ? either.right(`${key} is >= 0 (${a})`) : either.left(`${key} is < 0 (${a})`);
* assert.deepStrictEqual(partitionMapWithIndex(f)({ a: -1, b: 2, c: 123 }), {
* left: {
* a: "a is < 0 (-1)",
* },
* right: {
* b: "b is >= 0 (2)",
* c: "c is >= 0 (123)",
* },
* });
*
* @since 2.0.0
*/
export const partitionMapWithIndex: <K extends string, A, B, C>(
f: (key: K, a: A) => Either<B, C>
) => (fa: Record<K, A>) => Separated<Record<string, B>, Record<string, C>> = RR.partitionMapWithIndex
/**
* Partition a `Record` into two parts according to a predicate
* that takes a key and a value.
*
* @example
* import { partitionWithIndex } from "fp-ts/Record"
*
* assert.deepStrictEqual(
* partitionWithIndex((key: string, a: number) => key.length <= 1 && a > 0)({ a: -1, b: 2, ccc: 7 }),
* {
* left: {
* a: -1,
* ccc: 7,
* },
* right: {
* b: 2,
* },
* }
* );
*
* @since 2.0.0
*/
export function partitionWithIndex<K extends string, A, B extends A>(
refinementWithIndex: RefinementWithIndex<K, A, B>
): (fa: Record<K, A>) => Separated<Record<string, A>, Record<string, B>>
export function partitionWithIndex<K extends string, A>(
predicateWithIndex: PredicateWithIndex<K, A>
): <B extends A>(fb: Record<K, B>) => Separated<Record<string, B>, Record<string, B>>
export function partitionWithIndex<K extends string, A>(
predicateWithIndex: PredicateWithIndex<K, A>
): (fa: Record<K, A>) => Separated<Record<string, A>, Record<string, A>>
export function partitionWithIndex<A>(
predicateWithIndex: PredicateWithIndex<string, A>
): (fa: Record<string, A>) => Separated<Record<string, A>, Record<string, A>> {
return RR.partitionWithIndex(predicateWithIndex)
}
/**
* Maps a `Record` with an iterating function that takes key and value and
* returns an `Option`, keeping only the `Some` values and discarding `None`s.
*
* @example
* import { filterMapWithIndex } from "fp-ts/Record"
* import { option } from "fp-ts"
*
* const f = (key: string, a: number) => (a >= 0 ? option.some(`${key}${a}`) : option.none);
* assert.deepStrictEqual(filterMapWithIndex(f)({ a: -1, b: 2, c: 3 }), {
* b: "b2",
* c: "c3",
* });
*
* @since 2.0.0
*/
export const filterMapWithIndex: <K extends string, A, B>(
f: (key: K, a: A) => Option<B>
) => (fa: Record<K, A>) => Record<string, B> = RR.filterMapWithIndex
/**
* Produce a new `Record` keeping only the entries that satisfy
* a predicate taking key and value as input.
*
* @example
* import { filterWithIndex } from "fp-ts/Record"
*
* assert.deepStrictEqual(
* filterWithIndex((s: string, v: number) => s.length <= 1 && v > 0)({ a: 1, b: -2, ccc: 3 }),
* {
* a: 1,
* }
* );
*
* @since 2.0.0
*/
export function filterWithIndex<K extends string, A, B extends A>(
refinementWithIndex: RefinementWithIndex<K, A, B>
): (fa: Record<K, A>) => Record<string, B>
export function filterWithIndex<K extends string, A>(
predicateWithIndex: PredicateWithIndex<K, A>
): <B extends A>(fb: Record<K, B>) => Record<string, B>
export function filterWithIndex<K extends string, A>(
predicateWithIndex: PredicateWithIndex<K, A>
): (fa: Record<K, A>) => Record<string, A>
export function filterWithIndex<A>(
predicateWithIndex: PredicateWithIndex<string, A>
): (fa: Record<string, A>) => Record<string, A> {
return RR.filterWithIndex(predicateWithIndex)
}
/**
* Create a `Record` from a foldable collection of key/value pairs, using the
* specified `Magma` to combine values for duplicate keys.
*
* @since 2.0.0
*/
export function fromFoldable<F extends URIS3, A>(
M: Magma<A>,
F: Foldable3<F>
): <R, E>(fka: Kind3<F, R, E, [string, A]>) => Record<string, A>
export function fromFoldable<F extends URIS2, A>(
M: Magma<A>,
F: Foldable2<F>
): <E>(fka: Kind2<F, E, [string, A]>) => Record<string, A>
export function fromFoldable<F extends URIS, A>(
M: Magma<A>,
F: Foldable1<F>
): (fka: Kind<F, [string, A]>) => Record<string, A>
export function fromFoldable<F, A>(M: Magma<A>, F: FoldableHKT<F>): (fka: HKT<F, [string, A]>) => Record<string, A>
export function fromFoldable<F, A>(M: Magma<A>, F: FoldableHKT<F>): (fka: HKT<F, [string, A]>) => Record<string, A> {
return RR.fromFoldable(M, F)
}
/**
* Alias of [`toArray`](#toArray).
*
* @example
* import { toEntries } from 'fp-ts/Record'
*
* assert.deepStrictEqual(toEntries({ b: 2, a: 1 }), [['a', 1], ['b', 2]])
*
* @since 2.12.0
* @category conversions
*/
export const toEntries = toArray
/**
* Converts an `Array` of `[key, value]` tuples into a `Record`.
*
* @example
* import { fromEntries } from 'fp-ts/Record'
*
* assert.deepStrictEqual(fromEntries([['a', 1], ['b', 2], ['a', 3]]), { b: 2, a: 3 })
*
* @since 2.12.0
* @category conversions
*/
export const fromEntries = <A>(fa: Array<[string, A]>): Record<string, A> => fromFoldable(Se.last<A>(), A.Foldable)(fa)
/**
* Create a `Record` from a foldable collection using the specified functions to
*
* - map to key/value pairs
* - combine values for duplicate keys.
*
* @example
* import { last } from 'fp-ts/Semigroup'
* import { Foldable, zip } from 'fp-ts/Array'
* import { identity } from 'fp-ts/function'
* import { fromFoldableMap } from 'fp-ts/Record'
*
* export const zipObject = <K extends string, A>(keys: Array<K>, values: Array<A>): Record<K, A> =>
* fromFoldableMap(last<A>(), Foldable)(zip(keys, values), identity)
*
* assert.deepStrictEqual(zipObject(['a', 'b'], [1, 2, 3]), { a: 1, b: 2 })
*
* interface User {
* readonly id: string
* readonly name: string
* }
*
* const users: Array<User> = [
* { id: 'id1', name: 'name1' },
* { id: 'id2', name: 'name2' },
* { id: 'id1', name: 'name3' }
* ]
*
* assert.deepStrictEqual(fromFoldableMap(last<User>(), Foldable)(users, user => [user.id, user]), {
* id1: { id: 'id1', name: 'name3' },
* id2: { id: 'id2', name: 'name2' }
* })
*
* @since 2.0.0
*/
export function fromFoldableMap<F extends URIS3, B>(
M: Magma<B>,
F: Foldable3<F>
): <R, E, A>(fa: Kind3<F, R, E, A>, f: (a: A) => [string, B]) => Record<string, B>
export function fromFoldableMap<F extends URIS2, B>(
M: Magma<B>,
F: Foldable2<F>
): <E, A>(fa: Kind2<F, E, A>, f: (a: A) => [string, B]) => Record<string, B>
export function fromFoldableMap<F extends URIS, B>(
M: Magma<B>,
F: Foldable1<F>
): <A>(fa: Kind<F, A>, f: (a: A) => [string, B]) => Record<string, B>
export function fromFoldableMap<F, B>(
M: Magma<B>,
F: FoldableHKT<F>
): <A>(fa: HKT<F, A>, f: (a: A) => [string, B]) => Record<string, B>
export function fromFoldableMap<F, B>(
M: Magma<B>,
F: FoldableHKT<F>
): <A>(fa: HKT<F, A>, f: (a: A) => [string, B]) => Record<string, B> {
return RR.fromFoldableMap(M, F)
}
/**
* Test if every value in a `Record` satisfies the predicate.
*
* @example
* import { every } from "fp-ts/Record"
*
* assert.deepStrictEqual(every((n: number) => n >= 0)({ a: 1, b: 2 }), true);
* assert.deepStrictEqual(every((n: number) => n >= 0)({ a: 1, b: -1 }), false);
*
* @since 2.0.0
*/
export const every: {
<A, B extends A>(refinement: Refinement<A, B>): Refinement<Record<string, A>, Record<string, B>>
<A>(predicate: Predicate<A>): Predicate<Record<string, A>>
} = RR.every as any
/**
* Test if at least one value in a `Record` satisfies the predicate.
*
* @example
* import { some } from "fp-ts/Record"
*
* assert.deepStrictEqual(some((n: number) => n >= 0)({ a: 1, b: -2 }), true);
* assert.deepStrictEqual(some((n: number) => n >= 0)({ a: -1, b: -2 }), false);
*
* @since 2.0.0
*/
export const some: <A>(predicate: (a: A) => boolean) => (r: Record<string, A>) => boolean = RR.some
// TODO: remove non-curried overloading in v3
/**
* Given an `Eq` checks if a `Record` contains an entry with
* value equal to a provided value.
*
* @example
* import { elem } from "fp-ts/Record"
* import { number } from "fp-ts"
*
* assert.deepStrictEqual(elem(number.Eq)(123, { foo: 123, bar: 234 }), true);
* assert.deepStrictEqual(elem(number.Eq)(-7, { foo: 123, bar: 234 }), false);
*
* @since 2.0.0
*/
export const elem: <A>(E: Eq<A>) => {
(a: A): (fa: Record<string, A>) => boolean
(a: A, fa: Record<string, A>): boolean
} = RR.elem
/**
* Union of two `Record`s.
* Takes two `Record`s and produces a `Record` combining all the
* entries of the two inputs.
* It uses the `concat` function of the provided `Magma` to
* combine the elements with the same key.
*
* @example
* import { union } from "fp-ts/Record";
* import { Magma } from "fp-ts/Magma";
*
* const m1: Magma<number> = { concat: (x: number, y: number) => x + y };
* assert.deepStrictEqual(union(m1)({ a: 3, c: 3 })({ a: 1, b: 2 }), { a: 4, b: 2, c: 3 });
* const m2: Magma<number> = { concat: (x: number) => x };
* assert.deepStrictEqual(union(m2)({ a: 3, c: 3 })({ a: 1, b: 2 }), { a: 1, b: 2, c: 3 });
*
* @since 2.11.0
*/
export const union = <A>(
M: Magma<A>
): ((second: Record<string, A>) => (first: Record<string, A>) => Record<string, A>) => {
const unionM = RR.union(M)
return (second) => (first) => {
if (isEmpty(first)) {
return { ...second }
}
if (isEmpty(second)) {
return { ...first }
}
return unionM(second)(first)
}
}
/**
* Intersection of two `Record`s.
* Takes two `Record`s and produces a `Record` combining only the
* entries of the two inputswith the same key.
* It uses the `concat` function of the provided `Magma` to
* combine the elements.
*
* @example
* import { intersection } from "fp-ts/Record";
* import { Magma } from "fp-ts/Magma";
*
* const m1: Magma<number> = { concat: (x: number, y: number) => x + y };
* assert.deepStrictEqual(intersection(m1)({ a: 3, c: 3 })({ a: 1, b: 2 }), { a: 4});
* const m2: Magma<number> = { concat: (x: number) => x };
* assert.deepStrictEqual(intersection(m2)({ a: 3, c: 3 })({ a: 1, b: 2 }), { a: 1});
*
* @since 2.11.0
*/
export const intersection =
<A>(M: Magma<A>) =>
(second: Record<string, A>) =>
(first: Record<string, A>): Record<string, A> => {
if (isEmpty(first) || isEmpty(second)) {
return {}
}
return RR.intersection(M)(second)(first)
}
/**
* Difference between two `Record`s.
* Takes two `Record`s and produces a `Record` composed by the
* entries of the two inputs, removing the entries with the same
* key in both inputs.
*
* @example
* import { difference } from "fp-ts/Record";
*
* assert.deepStrictEqual(difference({ a: 1 })({ a: 1, b: 2 }), { b: 2 });
* assert.deepStrictEqual(difference({ a: 3 })({ a: 1, b: 2 }), { b: 2 });
* assert.deepStrictEqual(difference({ a: 3, c: 3 })({ a: 1, b: 2 }), { b: 2, c: 3 });
*
* @since 2.11.0
*/
export const difference =
<A>(second: Record<string, A>) =>
(first: Record<string, A>): Record<string, A> => {
if (isEmpty(first)) {
return { ...second }
}