/
Reader.ts
495 lines (437 loc) · 11 KB
/
Reader.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
/**
* @since 2.0.0
*/
import { Applicative2, getApplicativeMonoid } from './Applicative'
import { apFirst as apFirst_, Apply2, apSecond as apSecond_, apS as apS_, getApplySemigroup } from './Apply'
import { Category2 } from './Category'
import { Choice2 } from './Choice'
import * as E from './Either'
import { constant, flow, identity, pipe } from './function'
import { bindTo as bindTo_, flap as flap_, Functor2 } from './Functor'
import { bind as bind_, Chain2, chainFirst as chainFirst_ } from './Chain'
import { Monoid } from './Monoid'
import { Pointed2 } from './Pointed'
import { Profunctor2 } from './Profunctor'
import { Semigroup } from './Semigroup'
import { Strong2 } from './Strong'
import { Monad2 } from './Monad'
// -------------------------------------------------------------------------------------
// model
// -------------------------------------------------------------------------------------
/**
* @category model
* @since 2.0.0
*/
export interface Reader<R, A> {
(r: R): A
}
// -------------------------------------------------------------------------------------
// constructors
// -------------------------------------------------------------------------------------
/**
* Reads the current context
*
* @category constructors
* @since 2.0.0
*/
export const ask: <R>() => Reader<R, R> = () => identity
/**
* Projects a value from the global context in a Reader
*
* @category constructors
* @since 2.0.0
*/
export const asks: <R, A>(f: (r: R) => A) => Reader<R, A> = identity
// -------------------------------------------------------------------------------------
// combinators
// -------------------------------------------------------------------------------------
/**
* Changes the value of the local context during the execution of the action `ma` (similar to `Contravariant`'s
* `contramap`).
*
* @category combinators
* @since 2.0.0
*/
export const local: <R2, R1>(f: (r2: R2) => R1) => <A>(ma: Reader<R1, A>) => Reader<R2, A> = (f) => (ma) => (r2) =>
ma(f(r2))
// -------------------------------------------------------------------------------------
// non-pipeables
// -------------------------------------------------------------------------------------
/* istanbul ignore next */
const _map: Monad2<URI>['map'] = (fa, f) => pipe(fa, map(f))
/* istanbul ignore next */
const _ap: Monad2<URI>['ap'] = (fab, fa) => pipe(fab, ap(fa))
/* istanbul ignore next */
const _chain: Monad2<URI>['chain'] = (ma, f) => pipe(ma, chain(f))
const _compose: Category2<URI>['compose'] = (bc, ab) => pipe(bc, compose(ab))
const _promap: Profunctor2<URI>['promap'] = (fea, f, g) => pipe(fea, promap(f, g))
// -------------------------------------------------------------------------------------
// type class members
// -------------------------------------------------------------------------------------
/**
* `map` can be used to turn functions `(a: A) => B` into functions `(fa: F<A>) => F<B>` whose argument and return types
* use the type constructor `F` to represent some computational context.
*
* @category Functor
* @since 2.0.0
*/
export const map: <A, B>(f: (a: A) => B) => <R>(fa: Reader<R, A>) => Reader<R, B> = (f) => (fa) => (r) => f(fa(r))
/**
* Less strict version of [`ap`](#ap).
*
* @category Apply
* @since 2.8.0
*/
export const apW: <R2, A>(fa: Reader<R2, A>) => <R1, B>(fab: Reader<R1, (a: A) => B>) => Reader<R1 & R2, B> = (fa) => (
fab
) => (r) => fab(r)(fa(r))
/**
* Apply a function to an argument under a type constructor.
*
* @category Apply
* @since 2.0.0
*/
export const ap: <R, A>(fa: Reader<R, A>) => <B>(fab: Reader<R, (a: A) => B>) => Reader<R, B> = apW
/**
* @category Pointed
* @since 2.0.0
*/
export const of: Pointed2<URI>['of'] = constant
/**
* Less strict version of [`chain`](#chain).
*
* @category Monad
* @since 2.6.0
*/
export const chainW: <R2, A, B>(f: (a: A) => Reader<R2, B>) => <R1>(ma: Reader<R1, A>) => Reader<R1 & R2, B> = (f) => (
fa
) => (r) => f(fa(r))(r)
/**
* Composes computations in sequence, using the return value of one computation to determine the next computation.
*
* @category Monad
* @since 2.0.0
*/
export const chain: <A, R, B>(f: (a: A) => Reader<R, B>) => (ma: Reader<R, A>) => Reader<R, B> = chainW
/**
* Derivable from `Chain`.
*
* @category combinators
* @since 2.0.0
*/
export const flatten: <R, A>(mma: Reader<R, Reader<R, A>>) => Reader<R, A> =
/*#__PURE__*/
chain(identity)
/**
* @category Semigroupoid
* @since 2.0.0
*/
export const compose: <A, B>(ab: Reader<A, B>) => <C>(bc: Reader<B, C>) => Reader<A, C> = (ab) => (bc) => flow(ab, bc)
/**
* @category Profunctor
* @since 2.0.0
*/
export const promap: <E, A, D, B>(f: (d: D) => E, g: (a: A) => B) => (fea: Reader<E, A>) => Reader<D, B> = (f, g) => (
fea
) => (a) => g(fea(f(a)))
/**
* @category Category
* @since 2.0.0
*/
export const id: Category2<URI>['id'] = () => identity
/**
* @category Strong
* @since 2.10.0
*/
export const first: Strong2<URI>['first'] = (pab) => ([a, c]) => [pab(a), c]
/**
* @category Strong
* @since 2.10.0
*/
export const second: Strong2<URI>['second'] = (pbc) => ([a, b]) => [a, pbc(b)]
/**
* @category Choice
* @since 2.10.0
*/
export const left: Choice2<URI>['left'] = (pab) => E.fold((a) => E.left(pab(a)), E.right)
/**
* @category Choice
* @since 2.10.0
*/
export const right: Choice2<URI>['right'] = (pbc) => E.fold(E.left, (b) => E.right(pbc(b)))
// -------------------------------------------------------------------------------------
// instances
// -------------------------------------------------------------------------------------
/**
* @category instances
* @since 2.0.0
*/
export const URI = 'Reader'
/**
* @category instances
* @since 2.0.0
*/
export type URI = typeof URI
declare module './HKT' {
interface URItoKind2<E, A> {
readonly [URI]: Reader<E, A>
}
}
/**
* @category instances
* @since 2.7.0
*/
export const Functor: Functor2<URI> = {
URI,
map: _map
}
/**
* Derivable from `Functor`.
*
* @category combinators
* @since 2.10.0
*/
export const flap =
/*#_PURE_*/
flap_(Functor)
/**
* @category instances
* @since 2.10.0
*/
export const Pointed: Pointed2<URI> = {
URI,
of
}
/**
* @category instances
* @since 2.10.0
*/
export const Apply: Apply2<URI> = {
URI,
map: _map,
ap: _ap
}
/**
* Combine two effectful actions, keeping only the result of the first.
*
* Derivable from `Apply`.
*
* @category combinators
* @since 2.0.0
*/
export const apFirst =
/*#__PURE__*/
apFirst_(Apply)
/**
* Combine two effectful actions, keeping only the result of the second.
*
* Derivable from `Apply`.
*
* @category combinators
* @since 2.0.0
*/
export const apSecond =
/*#__PURE__*/
apSecond_(Apply)
/**
* @category instances
* @since 2.7.0
*/
export const Applicative: Applicative2<URI> = {
URI,
map: _map,
ap: _ap,
of
}
/**
* @category instances
* @since 2.10.0
*/
export const Chain: Chain2<URI> = {
URI,
map: _map,
ap: _ap,
chain: _chain
}
/**
* @category instances
* @since 2.7.0
*/
export const Monad: Monad2<URI> = {
URI,
map: _map,
of,
ap: _ap,
chain: _chain
}
/**
* Composes computations in sequence, using the return value of one computation to determine the next computation and
* keeping only the result of the first.
*
* Derivable from `Chain`.
*
* @category combinators
* @since 2.0.0
*/
export const chainFirst =
/*#__PURE__*/
chainFirst_(Chain)
/**
* @category instances
* @since 2.7.0
*/
export const Profunctor: Profunctor2<URI> = {
URI,
map: _map,
promap: _promap
}
/**
* @category instances
* @since 2.7.0
*/
export const Category: Category2<URI> = {
URI,
compose: _compose,
id
}
/**
* @category instances
* @since 2.8.3
*/
export const Strong: Strong2<URI> = {
URI,
map: _map,
promap: _promap,
first,
second
}
/**
* @category instances
* @since 2.8.3
*/
export const Choice: Choice2<URI> = {
URI,
map: _map,
promap: _promap,
left,
right
}
// -------------------------------------------------------------------------------------
// do notation
// -------------------------------------------------------------------------------------
/**
* @since 2.8.0
*/
export const bindTo =
/*#__PURE__*/
bindTo_(Functor)
/**
* @since 2.8.0
*/
export const bind =
/*#__PURE__*/
bind_(Chain)
/**
* @since 2.8.0
*/
export const bindW: <N extends string, A, R2, B>(
name: Exclude<N, keyof A>,
f: (a: A) => Reader<R2, B>
) => <R1>(
fa: Reader<R1, A>
) => Reader<R1 & R2, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }> = bind as any
// -------------------------------------------------------------------------------------
// pipeable sequence S
// -------------------------------------------------------------------------------------
/**
* @since 2.9.0
*/
export const Do: Reader<unknown, {}> =
/*#__PURE__*/
of({})
/**
* @since 2.8.0
*/
export const apS =
/*#__PURE__*/
apS_(Apply)
/**
* @since 2.8.0
*/
export const apSW: <A, N extends string, R2, B>(
name: Exclude<N, keyof A>,
fb: Reader<R2, B>
) => <R1>(
fa: Reader<R1, A>
) => Reader<R1 & R2, { readonly [K in keyof A | N]: K extends keyof A ? A[K] : B }> = apS as any
// -------------------------------------------------------------------------------------
// array utils
// -------------------------------------------------------------------------------------
/**
* Equivalent to `ReadonlyArray#traverseWithIndex(Applicative)`.
*
* @since 2.9.0
*/
export const traverseArrayWithIndex = <R, A, B>(f: (index: number, a: A) => Reader<R, B>) => (
as: ReadonlyArray<A>
): Reader<R, ReadonlyArray<B>> => (r) => as.map((x, i) => f(i, x)(r))
/**
* Equivalent to `ReadonlyArray#traverse(Applicative)`.
*
* @since 2.9.0
*/
export const traverseArray = <R, A, B>(
f: (a: A) => Reader<R, B>
): ((as: ReadonlyArray<A>) => Reader<R, ReadonlyArray<B>>) => traverseArrayWithIndex((_, a) => f(a))
/**
* Equivalent to `ReadonlyArray#sequence(Applicative)`.
*
* @since 2.9.0
*/
export const sequenceArray: <R, A>(arr: ReadonlyArray<Reader<R, A>>) => Reader<R, ReadonlyArray<A>> =
/*#__PURE__*/
traverseArray(identity)
// -------------------------------------------------------------------------------------
// deprecated
// -------------------------------------------------------------------------------------
/**
* Use small, specific instances instead.
*
* @category instances
* @since 2.0.0
* @deprecated
*/
export const reader: Monad2<URI> & Profunctor2<URI> & Category2<URI> & Strong2<URI> & Choice2<URI> = {
URI,
map: _map,
of,
ap: _ap,
chain: _chain,
promap: _promap,
compose: _compose,
id,
first,
second,
left,
right
}
/**
* Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead.
*
* @category instances
* @since 2.0.0
* @deprecated
*/
export const getSemigroup: <R, A>(S: Semigroup<A>) => Semigroup<Reader<R, A>> =
/*#__PURE__*/
getApplySemigroup(Apply)
/**
* Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead.
*
* @category instances
* @since 2.0.0
* @deprecated
*/
export const getMonoid: <R, A>(M: Monoid<A>) => Monoid<Reader<R, A>> =
/*#__PURE__*/
getApplicativeMonoid(Applicative)