@clayroach/effect 3.19.14-source-capture.6 → 3.19.14-source-capture.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (371) hide show
  1. package/dist/cjs/Utils.js +1 -1
  2. package/dist/cjs/Utils.js.map +1 -1
  3. package/dist/cjs/internal/clock.js +1 -1
  4. package/dist/cjs/internal/clock.js.map +1 -1
  5. package/dist/esm/Utils.js +1 -1
  6. package/dist/esm/Utils.js.map +1 -1
  7. package/dist/esm/internal/clock.js +1 -1
  8. package/dist/esm/internal/clock.js.map +1 -1
  9. package/package.json +1 -1
  10. package/src/Arbitrary.ts +0 -1101
  11. package/src/Array.ts +0 -3589
  12. package/src/BigDecimal.ts +0 -1349
  13. package/src/BigInt.ts +0 -643
  14. package/src/Boolean.ts +0 -287
  15. package/src/Brand.ts +0 -360
  16. package/src/Cache.ts +0 -281
  17. package/src/Cause.ts +0 -1555
  18. package/src/Channel.ts +0 -2355
  19. package/src/ChildExecutorDecision.ts +0 -146
  20. package/src/Chunk.ts +0 -1495
  21. package/src/Clock.ts +0 -111
  22. package/src/Config.ts +0 -542
  23. package/src/ConfigError.ts +0 -270
  24. package/src/ConfigProvider.ts +0 -333
  25. package/src/ConfigProviderPathPatch.ts +0 -100
  26. package/src/Console.ts +0 -226
  27. package/src/Context.ts +0 -585
  28. package/src/Cron.ts +0 -706
  29. package/src/Data.ts +0 -596
  30. package/src/DateTime.ts +0 -1686
  31. package/src/DefaultServices.ts +0 -34
  32. package/src/Deferred.ts +0 -301
  33. package/src/Differ.ts +0 -450
  34. package/src/Duration.ts +0 -1000
  35. package/src/Effect.ts +0 -14839
  36. package/src/Effectable.ts +0 -107
  37. package/src/Either.ts +0 -1040
  38. package/src/Encoding.ts +0 -195
  39. package/src/Equal.ts +0 -98
  40. package/src/Equivalence.ts +0 -235
  41. package/src/ExecutionPlan.ts +0 -308
  42. package/src/ExecutionStrategy.ts +0 -119
  43. package/src/Exit.ts +0 -467
  44. package/src/FastCheck.ts +0 -9
  45. package/src/Fiber.ts +0 -744
  46. package/src/FiberHandle.ts +0 -540
  47. package/src/FiberId.ts +0 -195
  48. package/src/FiberMap.ts +0 -656
  49. package/src/FiberRef.ts +0 -431
  50. package/src/FiberRefs.ts +0 -204
  51. package/src/FiberRefsPatch.ts +0 -105
  52. package/src/FiberSet.ts +0 -491
  53. package/src/FiberStatus.ts +0 -108
  54. package/src/Function.ts +0 -1222
  55. package/src/GlobalValue.ts +0 -53
  56. package/src/Graph.ts +0 -3732
  57. package/src/GroupBy.ts +0 -103
  58. package/src/HKT.ts +0 -45
  59. package/src/Hash.ts +0 -195
  60. package/src/HashMap.ts +0 -519
  61. package/src/HashRing.ts +0 -317
  62. package/src/HashSet.ts +0 -2346
  63. package/src/Inspectable.ts +0 -287
  64. package/src/Iterable.ts +0 -1119
  65. package/src/JSONSchema.ts +0 -1044
  66. package/src/KeyedPool.ts +0 -167
  67. package/src/Layer.ts +0 -1251
  68. package/src/LayerMap.ts +0 -436
  69. package/src/List.ts +0 -977
  70. package/src/LogLevel.ts +0 -285
  71. package/src/LogSpan.ts +0 -25
  72. package/src/Logger.ts +0 -702
  73. package/src/Mailbox.ts +0 -268
  74. package/src/ManagedRuntime.ts +0 -180
  75. package/src/Match.ts +0 -1477
  76. package/src/MergeDecision.ts +0 -95
  77. package/src/MergeState.ts +0 -172
  78. package/src/MergeStrategy.ts +0 -107
  79. package/src/Metric.ts +0 -780
  80. package/src/MetricBoundaries.ts +0 -69
  81. package/src/MetricHook.ts +0 -151
  82. package/src/MetricKey.ts +0 -224
  83. package/src/MetricKeyType.ts +0 -262
  84. package/src/MetricLabel.ts +0 -47
  85. package/src/MetricPair.ts +0 -71
  86. package/src/MetricPolling.ts +0 -148
  87. package/src/MetricRegistry.ts +0 -48
  88. package/src/MetricState.ts +0 -257
  89. package/src/Micro.ts +0 -4405
  90. package/src/ModuleVersion.ts +0 -18
  91. package/src/MutableHashMap.ts +0 -411
  92. package/src/MutableHashSet.ts +0 -706
  93. package/src/MutableList.ts +0 -297
  94. package/src/MutableQueue.ts +0 -227
  95. package/src/MutableRef.ts +0 -202
  96. package/src/NonEmptyIterable.ts +0 -32
  97. package/src/Number.ts +0 -1071
  98. package/src/Option.ts +0 -2170
  99. package/src/Order.ts +0 -373
  100. package/src/Ordering.ts +0 -111
  101. package/src/ParseResult.ts +0 -2031
  102. package/src/PartitionedSemaphore.ts +0 -200
  103. package/src/Pipeable.ts +0 -566
  104. package/src/Pool.ts +0 -204
  105. package/src/Predicate.ts +0 -1405
  106. package/src/Pretty.ts +0 -205
  107. package/src/PrimaryKey.ts +0 -23
  108. package/src/PubSub.ts +0 -182
  109. package/src/Queue.ts +0 -644
  110. package/src/Random.ts +0 -204
  111. package/src/RateLimiter.ts +0 -138
  112. package/src/RcMap.ts +0 -141
  113. package/src/RcRef.ts +0 -122
  114. package/src/Readable.ts +0 -93
  115. package/src/Record.ts +0 -1274
  116. package/src/RedBlackTree.ts +0 -421
  117. package/src/Redacted.ts +0 -144
  118. package/src/Ref.ts +0 -180
  119. package/src/RegExp.ts +0 -38
  120. package/src/Reloadable.ts +0 -127
  121. package/src/Request.ts +0 -347
  122. package/src/RequestBlock.ts +0 -118
  123. package/src/RequestResolver.ts +0 -366
  124. package/src/Resource.ts +0 -119
  125. package/src/Runtime.ts +0 -383
  126. package/src/RuntimeFlags.ts +0 -368
  127. package/src/RuntimeFlagsPatch.ts +0 -183
  128. package/src/STM.ts +0 -2045
  129. package/src/Schedule.ts +0 -2219
  130. package/src/ScheduleDecision.ts +0 -62
  131. package/src/ScheduleInterval.ts +0 -151
  132. package/src/ScheduleIntervals.ts +0 -122
  133. package/src/Scheduler.ts +0 -353
  134. package/src/Schema.ts +0 -10914
  135. package/src/SchemaAST.ts +0 -3043
  136. package/src/Scope.ts +0 -204
  137. package/src/ScopedCache.ts +0 -151
  138. package/src/ScopedRef.ts +0 -117
  139. package/src/Secret.ts +0 -88
  140. package/src/SingleProducerAsyncInput.ts +0 -67
  141. package/src/Sink.ts +0 -1461
  142. package/src/SortedMap.ts +0 -287
  143. package/src/SortedSet.ts +0 -390
  144. package/src/Stream.ts +0 -6468
  145. package/src/StreamEmit.ts +0 -136
  146. package/src/StreamHaltStrategy.ts +0 -123
  147. package/src/Streamable.ts +0 -45
  148. package/src/String.ts +0 -778
  149. package/src/Struct.ts +0 -243
  150. package/src/Subscribable.ts +0 -100
  151. package/src/SubscriptionRef.ts +0 -298
  152. package/src/Supervisor.ts +0 -240
  153. package/src/Symbol.ts +0 -29
  154. package/src/SynchronizedRef.ts +0 -270
  155. package/src/TArray.ts +0 -495
  156. package/src/TDeferred.ts +0 -100
  157. package/src/TMap.ts +0 -515
  158. package/src/TPriorityQueue.ts +0 -223
  159. package/src/TPubSub.ts +0 -200
  160. package/src/TQueue.ts +0 -432
  161. package/src/TRandom.ts +0 -129
  162. package/src/TReentrantLock.ts +0 -224
  163. package/src/TRef.ts +0 -178
  164. package/src/TSemaphore.ts +0 -129
  165. package/src/TSet.ts +0 -365
  166. package/src/TSubscriptionRef.ts +0 -192
  167. package/src/Take.ts +0 -258
  168. package/src/TestAnnotation.ts +0 -158
  169. package/src/TestAnnotationMap.ts +0 -119
  170. package/src/TestAnnotations.ts +0 -117
  171. package/src/TestClock.ts +0 -556
  172. package/src/TestConfig.ts +0 -47
  173. package/src/TestContext.ts +0 -36
  174. package/src/TestLive.ts +0 -53
  175. package/src/TestServices.ts +0 -390
  176. package/src/TestSized.ts +0 -55
  177. package/src/Tracer.ts +0 -198
  178. package/src/Trie.ts +0 -840
  179. package/src/Tuple.ts +0 -305
  180. package/src/Types.ts +0 -353
  181. package/src/Unify.ts +0 -113
  182. package/src/UpstreamPullRequest.ts +0 -117
  183. package/src/UpstreamPullStrategy.ts +0 -121
  184. package/src/Utils.ts +0 -809
  185. package/src/index.ts +0 -1561
  186. package/src/internal/array.ts +0 -8
  187. package/src/internal/blockedRequests.ts +0 -520
  188. package/src/internal/cache.ts +0 -733
  189. package/src/internal/cause.ts +0 -1050
  190. package/src/internal/channel/channelExecutor.ts +0 -1200
  191. package/src/internal/channel/channelState.ts +0 -134
  192. package/src/internal/channel/childExecutorDecision.ts +0 -96
  193. package/src/internal/channel/continuation.ts +0 -200
  194. package/src/internal/channel/mergeDecision.ts +0 -113
  195. package/src/internal/channel/mergeState.ts +0 -120
  196. package/src/internal/channel/mergeStrategy.ts +0 -72
  197. package/src/internal/channel/singleProducerAsyncInput.ts +0 -259
  198. package/src/internal/channel/subexecutor.ts +0 -229
  199. package/src/internal/channel/upstreamPullRequest.ts +0 -84
  200. package/src/internal/channel/upstreamPullStrategy.ts +0 -87
  201. package/src/internal/channel.ts +0 -2603
  202. package/src/internal/clock.ts +0 -95
  203. package/src/internal/completedRequestMap.ts +0 -9
  204. package/src/internal/concurrency.ts +0 -54
  205. package/src/internal/config.ts +0 -716
  206. package/src/internal/configError.ts +0 -304
  207. package/src/internal/configProvider/pathPatch.ts +0 -97
  208. package/src/internal/configProvider.ts +0 -799
  209. package/src/internal/console.ts +0 -153
  210. package/src/internal/context.ts +0 -337
  211. package/src/internal/core-effect.ts +0 -2293
  212. package/src/internal/core-stream.ts +0 -998
  213. package/src/internal/core.ts +0 -3273
  214. package/src/internal/data.ts +0 -36
  215. package/src/internal/dataSource.ts +0 -327
  216. package/src/internal/dateTime.ts +0 -1277
  217. package/src/internal/defaultServices/console.ts +0 -100
  218. package/src/internal/defaultServices.ts +0 -163
  219. package/src/internal/deferred.ts +0 -46
  220. package/src/internal/differ/chunkPatch.ts +0 -211
  221. package/src/internal/differ/contextPatch.ts +0 -232
  222. package/src/internal/differ/hashMapPatch.ts +0 -220
  223. package/src/internal/differ/hashSetPatch.ts +0 -176
  224. package/src/internal/differ/orPatch.ts +0 -311
  225. package/src/internal/differ/readonlyArrayPatch.ts +0 -210
  226. package/src/internal/differ.ts +0 -200
  227. package/src/internal/doNotation.ts +0 -80
  228. package/src/internal/effect/circular.ts +0 -905
  229. package/src/internal/effectable.ts +0 -131
  230. package/src/internal/either.ts +0 -110
  231. package/src/internal/encoding/base64.ts +0 -286
  232. package/src/internal/encoding/base64Url.ts +0 -29
  233. package/src/internal/encoding/common.ts +0 -51
  234. package/src/internal/encoding/hex.ts +0 -315
  235. package/src/internal/errors.ts +0 -7
  236. package/src/internal/executionPlan.ts +0 -114
  237. package/src/internal/executionStrategy.ts +0 -74
  238. package/src/internal/fiber.ts +0 -388
  239. package/src/internal/fiberId.ts +0 -267
  240. package/src/internal/fiberMessage.ts +0 -82
  241. package/src/internal/fiberRefs/patch.ts +0 -144
  242. package/src/internal/fiberRefs.ts +0 -297
  243. package/src/internal/fiberRuntime.ts +0 -3915
  244. package/src/internal/fiberScope.ts +0 -71
  245. package/src/internal/fiberStatus.ts +0 -119
  246. package/src/internal/groupBy.ts +0 -530
  247. package/src/internal/hashMap/array.ts +0 -49
  248. package/src/internal/hashMap/bitwise.ts +0 -32
  249. package/src/internal/hashMap/config.ts +0 -14
  250. package/src/internal/hashMap/keySet.ts +0 -8
  251. package/src/internal/hashMap/node.ts +0 -391
  252. package/src/internal/hashMap.ts +0 -586
  253. package/src/internal/hashSet.ts +0 -323
  254. package/src/internal/keyedPool.ts +0 -244
  255. package/src/internal/layer/circular.ts +0 -228
  256. package/src/internal/layer.ts +0 -1487
  257. package/src/internal/logSpan.ts +0 -20
  258. package/src/internal/logger-circular.ts +0 -24
  259. package/src/internal/logger.ts +0 -485
  260. package/src/internal/mailbox.ts +0 -561
  261. package/src/internal/managedRuntime/circular.ts +0 -6
  262. package/src/internal/managedRuntime.ts +0 -134
  263. package/src/internal/matcher.ts +0 -652
  264. package/src/internal/metric/boundaries.ts +0 -75
  265. package/src/internal/metric/hook.ts +0 -483
  266. package/src/internal/metric/key.ts +0 -167
  267. package/src/internal/metric/keyType.ts +0 -238
  268. package/src/internal/metric/label.ts +0 -41
  269. package/src/internal/metric/pair.ts +0 -48
  270. package/src/internal/metric/polling.ts +0 -149
  271. package/src/internal/metric/registry.ts +0 -187
  272. package/src/internal/metric/state.ts +0 -290
  273. package/src/internal/metric.ts +0 -577
  274. package/src/internal/opCodes/cause.ts +0 -35
  275. package/src/internal/opCodes/channel.ts +0 -83
  276. package/src/internal/opCodes/channelChildExecutorDecision.ts +0 -17
  277. package/src/internal/opCodes/channelMergeDecision.ts +0 -11
  278. package/src/internal/opCodes/channelMergeState.ts +0 -17
  279. package/src/internal/opCodes/channelMergeStrategy.ts +0 -11
  280. package/src/internal/opCodes/channelState.ts +0 -23
  281. package/src/internal/opCodes/channelUpstreamPullRequest.ts +0 -11
  282. package/src/internal/opCodes/channelUpstreamPullStrategy.ts +0 -11
  283. package/src/internal/opCodes/config.ts +0 -65
  284. package/src/internal/opCodes/configError.ts +0 -35
  285. package/src/internal/opCodes/continuation.ts +0 -11
  286. package/src/internal/opCodes/deferred.ts +0 -11
  287. package/src/internal/opCodes/effect.ts +0 -89
  288. package/src/internal/opCodes/layer.ts +0 -59
  289. package/src/internal/opCodes/streamHaltStrategy.ts +0 -23
  290. package/src/internal/option.ts +0 -80
  291. package/src/internal/pool.ts +0 -432
  292. package/src/internal/pubsub.ts +0 -1762
  293. package/src/internal/query.ts +0 -204
  294. package/src/internal/queue.ts +0 -766
  295. package/src/internal/random.ts +0 -161
  296. package/src/internal/rateLimiter.ts +0 -93
  297. package/src/internal/rcMap.ts +0 -285
  298. package/src/internal/rcRef.ts +0 -192
  299. package/src/internal/redBlackTree/iterator.ts +0 -200
  300. package/src/internal/redBlackTree/node.ts +0 -68
  301. package/src/internal/redBlackTree.ts +0 -1245
  302. package/src/internal/redacted.ts +0 -73
  303. package/src/internal/ref.ts +0 -171
  304. package/src/internal/reloadable.ts +0 -140
  305. package/src/internal/request.ts +0 -177
  306. package/src/internal/resource.ts +0 -76
  307. package/src/internal/ringBuffer.ts +0 -68
  308. package/src/internal/runtime.ts +0 -558
  309. package/src/internal/runtimeFlags.ts +0 -188
  310. package/src/internal/runtimeFlagsPatch.ts +0 -103
  311. package/src/internal/schedule/decision.ts +0 -47
  312. package/src/internal/schedule/interval.ts +0 -101
  313. package/src/internal/schedule/intervals.ts +0 -180
  314. package/src/internal/schedule.ts +0 -2199
  315. package/src/internal/schema/errors.ts +0 -191
  316. package/src/internal/schema/schemaId.ts +0 -106
  317. package/src/internal/schema/util.ts +0 -50
  318. package/src/internal/scopedCache.ts +0 -644
  319. package/src/internal/scopedRef.ts +0 -118
  320. package/src/internal/secret.ts +0 -89
  321. package/src/internal/singleShotGen.ts +0 -35
  322. package/src/internal/sink.ts +0 -2120
  323. package/src/internal/stack.ts +0 -10
  324. package/src/internal/stm/core.ts +0 -817
  325. package/src/internal/stm/entry.ts +0 -59
  326. package/src/internal/stm/journal.ts +0 -123
  327. package/src/internal/stm/opCodes/stm.ts +0 -71
  328. package/src/internal/stm/opCodes/stmState.ts +0 -17
  329. package/src/internal/stm/opCodes/strategy.ts +0 -17
  330. package/src/internal/stm/opCodes/tExit.ts +0 -29
  331. package/src/internal/stm/opCodes/tryCommit.ts +0 -11
  332. package/src/internal/stm/stm.ts +0 -1453
  333. package/src/internal/stm/stmState.ts +0 -136
  334. package/src/internal/stm/tArray.ts +0 -550
  335. package/src/internal/stm/tDeferred.ts +0 -81
  336. package/src/internal/stm/tExit.ts +0 -190
  337. package/src/internal/stm/tMap.ts +0 -824
  338. package/src/internal/stm/tPriorityQueue.ts +0 -267
  339. package/src/internal/stm/tPubSub.ts +0 -551
  340. package/src/internal/stm/tQueue.ts +0 -393
  341. package/src/internal/stm/tRandom.ts +0 -140
  342. package/src/internal/stm/tReentrantLock.ts +0 -352
  343. package/src/internal/stm/tRef.ts +0 -195
  344. package/src/internal/stm/tSemaphore.ts +0 -113
  345. package/src/internal/stm/tSet.ts +0 -259
  346. package/src/internal/stm/tSubscriptionRef.ts +0 -286
  347. package/src/internal/stm/tryCommit.ts +0 -34
  348. package/src/internal/stm/txnId.ts +0 -14
  349. package/src/internal/stm/versioned.ts +0 -4
  350. package/src/internal/stream/debounceState.ts +0 -57
  351. package/src/internal/stream/emit.ts +0 -123
  352. package/src/internal/stream/haltStrategy.ts +0 -94
  353. package/src/internal/stream/handoff.ts +0 -187
  354. package/src/internal/stream/handoffSignal.ts +0 -59
  355. package/src/internal/stream/pull.ts +0 -34
  356. package/src/internal/stream/sinkEndReason.ts +0 -30
  357. package/src/internal/stream/zipAllState.ts +0 -88
  358. package/src/internal/stream/zipChunksState.ts +0 -56
  359. package/src/internal/stream.ts +0 -8801
  360. package/src/internal/string-utils.ts +0 -107
  361. package/src/internal/subscriptionRef.ts +0 -138
  362. package/src/internal/supervisor/patch.ts +0 -190
  363. package/src/internal/supervisor.ts +0 -303
  364. package/src/internal/synchronizedRef.ts +0 -114
  365. package/src/internal/take.ts +0 -199
  366. package/src/internal/testing/sleep.ts +0 -27
  367. package/src/internal/testing/suspendedWarningData.ts +0 -85
  368. package/src/internal/testing/warningData.ts +0 -94
  369. package/src/internal/tracer.ts +0 -293
  370. package/src/internal/trie.ts +0 -722
  371. package/src/internal/version.ts +0 -7
package/src/Record.ts DELETED
@@ -1,1274 +0,0 @@
1
- /**
2
- * This module provides utility functions for working with records in TypeScript.
3
- *
4
- * @since 2.0.0
5
- */
6
-
7
- import type { Either } from "./Either.js"
8
- import * as E from "./Either.js"
9
- import * as Equal from "./Equal.js"
10
- import type { Equivalence } from "./Equivalence.js"
11
- import { dual, identity } from "./Function.js"
12
- import type { TypeLambda } from "./HKT.js"
13
- import * as Option from "./Option.js"
14
- import type { NoInfer } from "./Types.js"
15
-
16
- /**
17
- * @category models
18
- * @since 2.0.0
19
- */
20
- export type ReadonlyRecord<in out K extends string | symbol, out A> = {
21
- readonly [P in K]: A
22
- }
23
-
24
- /**
25
- * @since 2.0.0
26
- */
27
- export declare namespace ReadonlyRecord {
28
- type IsFiniteString<T extends string> = T extends "" ? true :
29
- [T] extends [`${infer Head}${infer Rest}`]
30
- ? string extends Head ? false : `${number}` extends Head ? false : Rest extends "" ? true : IsFiniteString<Rest>
31
- : false
32
-
33
- /**
34
- * @since 2.0.0
35
- */
36
- export type NonLiteralKey<K extends string | symbol> = K extends string ? IsFiniteString<K> extends true ? string : K
37
- : symbol
38
-
39
- /**
40
- * @since 2.0.0
41
- */
42
- export type IntersectKeys<K1 extends string, K2 extends string> = [string] extends [K1 | K2] ?
43
- NonLiteralKey<K1> & NonLiteralKey<K2>
44
- : K1 & K2
45
- }
46
-
47
- /**
48
- * @category type lambdas
49
- * @since 2.0.0
50
- */
51
- export interface ReadonlyRecordTypeLambda<K extends string = string> extends TypeLambda {
52
- readonly type: ReadonlyRecord<K, this["Target"]>
53
- }
54
-
55
- /**
56
- * Creates a new, empty record.
57
- *
58
- * @category constructors
59
- * @since 2.0.0
60
- */
61
- export const empty = <K extends string | symbol = never, V = never>(): Record<
62
- ReadonlyRecord.NonLiteralKey<K>,
63
- V
64
- > => ({} as any)
65
-
66
- /**
67
- * Determine if a record is empty.
68
- *
69
- * @example
70
- * ```ts
71
- * import * as assert from "node:assert"
72
- * import { isEmptyRecord } from "effect/Record"
73
- *
74
- * assert.deepStrictEqual(isEmptyRecord({}), true);
75
- * assert.deepStrictEqual(isEmptyRecord({ a: 3 }), false);
76
- * ```
77
- *
78
- * @category guards
79
- * @since 2.0.0
80
- */
81
- export const isEmptyRecord = <K extends string, A>(self: Record<K, A>): self is Record<K, never> =>
82
- keys(self).length === 0
83
-
84
- /**
85
- * Determine if a record is empty.
86
- *
87
- * @example
88
- * ```ts
89
- * import * as assert from "node:assert"
90
- * import { isEmptyReadonlyRecord } from "effect/Record"
91
- *
92
- * assert.deepStrictEqual(isEmptyReadonlyRecord({}), true);
93
- * assert.deepStrictEqual(isEmptyReadonlyRecord({ a: 3 }), false);
94
- * ```
95
- *
96
- * @category guards
97
- * @since 2.0.0
98
- */
99
- export const isEmptyReadonlyRecord: <K extends string, A>(
100
- self: ReadonlyRecord<K, A>
101
- ) => self is ReadonlyRecord<K, never> = isEmptyRecord
102
-
103
- /**
104
- * Takes an iterable and a projection function and returns a record.
105
- * The projection function maps each value of the iterable to a tuple of a key and a value, which is then added to the resulting record.
106
- *
107
- * @example
108
- * ```ts
109
- * import * as assert from "node:assert"
110
- * import { fromIterableWith } from "effect/Record"
111
- *
112
- * const input = [1, 2, 3, 4]
113
- *
114
- * assert.deepStrictEqual(
115
- * fromIterableWith(input, a => [String(a), a * 2]),
116
- * { '1': 2, '2': 4, '3': 6, '4': 8 }
117
- * )
118
- * ```
119
- *
120
- * @category constructors
121
- * @since 2.0.0
122
- */
123
- export const fromIterableWith: {
124
- <A, K extends string | symbol, B>(
125
- f: (a: A) => readonly [K, B]
126
- ): (self: Iterable<A>) => Record<ReadonlyRecord.NonLiteralKey<K>, B>
127
- <A, K extends string | symbol, B>(
128
- self: Iterable<A>,
129
- f: (a: A) => readonly [K, B]
130
- ): Record<ReadonlyRecord.NonLiteralKey<K>, B>
131
- } = dual(
132
- 2,
133
- <A, K extends string, B>(
134
- self: Iterable<A>,
135
- f: (a: A) => readonly [K, B]
136
- ): Record<ReadonlyRecord.NonLiteralKey<K>, B> => {
137
- const out: Record<string, B> = empty()
138
- for (const a of self) {
139
- const [k, b] = f(a)
140
- out[k] = b
141
- }
142
- return out
143
- }
144
- )
145
-
146
- /**
147
- * Creates a new record from an iterable, utilizing the provided function to determine the key for each element.
148
- *
149
- * @example
150
- * ```ts
151
- * import * as assert from "node:assert"
152
- * import { fromIterableBy } from "effect/Record"
153
- *
154
- * const users = [
155
- * { id: "2", name: "name2" },
156
- * { id: "1", name: "name1" }
157
- * ]
158
- *
159
- * assert.deepStrictEqual(
160
- * fromIterableBy(users, user => user.id),
161
- * {
162
- * "2": { id: "2", name: "name2" },
163
- * "1": { id: "1", name: "name1" }
164
- * }
165
- * )
166
- * ```
167
- *
168
- * @category constructors
169
- * @since 2.0.0
170
- */
171
- export const fromIterableBy = <A, K extends string | symbol>(
172
- items: Iterable<A>,
173
- f: (a: A) => K
174
- ): Record<ReadonlyRecord.NonLiteralKey<K>, A> => fromIterableWith(items, (a) => [f(a), a])
175
-
176
- /**
177
- * Builds a record from an iterable of key-value pairs.
178
- *
179
- * If there are conflicting keys when using `fromEntries`, the last occurrence of the key/value pair will overwrite the
180
- * previous ones. So the resulting record will only have the value of the last occurrence of each key.
181
- *
182
- * @example
183
- * ```ts
184
- * import * as assert from "node:assert"
185
- * import { fromEntries } from "effect/Record"
186
- *
187
- * const input: Array<[string, number]> = [["a", 1], ["b", 2]]
188
- *
189
- * assert.deepStrictEqual(fromEntries(input), { a: 1, b: 2 })
190
- * ```
191
- *
192
- * @since 2.0.0
193
- * @category constructors
194
- */
195
- export const fromEntries: <Entry extends readonly [string | symbol, any]>(
196
- entries: Iterable<Entry>
197
- ) => Record<ReadonlyRecord.NonLiteralKey<Entry[0]>, Entry[1]> = Object.fromEntries
198
-
199
- /**
200
- * Transforms the values of a record into an `Array` with a custom mapping function.
201
- *
202
- * @example
203
- * ```ts
204
- * import * as assert from "node:assert"
205
- * import { collect } from "effect/Record"
206
- *
207
- * const x = { a: 1, b: 2, c: 3 }
208
- * assert.deepStrictEqual(collect(x, (key, n) => [key, n]), [["a", 1], ["b", 2], ["c", 3]])
209
- * ```
210
- *
211
- * @category conversions
212
- * @since 2.0.0
213
- */
214
- export const collect: {
215
- <K extends string, A, B>(f: (key: K, a: A) => B): (self: ReadonlyRecord<K, A>) => Array<B>
216
- <K extends string, A, B>(self: ReadonlyRecord<K, A>, f: (key: K, a: A) => B): Array<B>
217
- } = dual(
218
- 2,
219
- <K extends string, A, B>(self: ReadonlyRecord<K, A>, f: (key: K, a: A) => B): Array<B> => {
220
- const out: Array<B> = []
221
- for (const key of keys(self)) {
222
- out.push(f(key, self[key]))
223
- }
224
- return out
225
- }
226
- )
227
-
228
- /**
229
- * Takes a record and returns an array of tuples containing its keys and values.
230
- *
231
- * @example
232
- * ```ts
233
- * import * as assert from "node:assert"
234
- * import { toEntries } from "effect/Record"
235
- *
236
- * const x = { a: 1, b: 2, c: 3 }
237
- * assert.deepStrictEqual(toEntries(x), [["a", 1], ["b", 2], ["c", 3]])
238
- * ```
239
- *
240
- * @category conversions
241
- * @since 2.0.0
242
- */
243
- export const toEntries: <K extends string, A>(self: ReadonlyRecord<K, A>) => Array<[K, A]> = collect((
244
- key,
245
- value
246
- ) => [key, value])
247
-
248
- /**
249
- * Returns the number of key/value pairs in a record.
250
- *
251
- * @example
252
- * ```ts
253
- * import * as assert from "node:assert"
254
- * import { size } from "effect/Record";
255
- *
256
- * assert.deepStrictEqual(size({ a: "a", b: 1, c: true }), 3);
257
- * ```
258
- *
259
- * @since 2.0.0
260
- */
261
- export const size = <K extends string, A>(self: ReadonlyRecord<K, A>): number => keys(self).length
262
-
263
- /**
264
- * Check if a given `key` exists in a record.
265
- *
266
- * @example
267
- * ```ts
268
- * import * as assert from "node:assert"
269
- * import { empty, has } from "effect/Record"
270
- *
271
- * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true);
272
- * assert.deepStrictEqual(has(empty<string>(), "c"), false);
273
- * ```
274
- *
275
- * @since 2.0.0
276
- */
277
- export const has: {
278
- <K extends string | symbol>(
279
- key: NoInfer<K>
280
- ): <A>(self: ReadonlyRecord<K, A>) => boolean
281
- <K extends string | symbol, A>(
282
- self: ReadonlyRecord<K, A>,
283
- key: NoInfer<K>
284
- ): boolean
285
- } = dual(
286
- 2,
287
- <K extends string | symbol, A>(
288
- self: ReadonlyRecord<K, A>,
289
- key: NoInfer<K>
290
- ): boolean => Object.prototype.hasOwnProperty.call(self, key)
291
- )
292
-
293
- /**
294
- * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`.
295
- *
296
- * @example
297
- * ```ts
298
- * import * as assert from "node:assert"
299
- * import { Record as R, Option } from "effect"
300
- *
301
- * const person: Record<string, unknown> = { name: "John Doe", age: 35 }
302
- *
303
- * assert.deepStrictEqual(R.get(person, "name"), Option.some("John Doe"))
304
- * assert.deepStrictEqual(R.get(person, "email"), Option.none())
305
- * ```
306
- *
307
- * @since 2.0.0
308
- */
309
- export const get: {
310
- <K extends string | symbol>(key: NoInfer<K>): <A>(self: ReadonlyRecord<K, A>) => Option.Option<A>
311
- <K extends string | symbol, A>(self: ReadonlyRecord<K, A>, key: NoInfer<K>): Option.Option<A>
312
- } = dual(
313
- 2,
314
- <K extends string | symbol, A>(self: ReadonlyRecord<K, A>, key: NoInfer<K>): Option.Option<A> =>
315
- has(self, key) ? Option.some(self[key]) : Option.none()
316
- )
317
-
318
- /**
319
- * Apply a function to the element at the specified key, creating a new record.
320
- * If the key does not exist, the record is returned unchanged.
321
- *
322
- * @example
323
- * ```ts
324
- * import * as assert from "node:assert"
325
- * import { Record as R } from "effect"
326
- *
327
- * const f = (x: number) => x * 2
328
- *
329
- * assert.deepStrictEqual(
330
- * R.modify({ a: 3 }, 'a', f),
331
- * { a: 6 }
332
- * )
333
- * assert.deepStrictEqual(
334
- * R.modify({ a: 3 } as Record<string, number>, 'b', f),
335
- * { a: 3 }
336
- * )
337
- * ```
338
- *
339
- * @since 2.0.0
340
- */
341
- export const modify: {
342
- <K extends string | symbol, A, B>(
343
- key: NoInfer<K>,
344
- f: (a: A) => B
345
- ): (self: ReadonlyRecord<K, A>) => Record<K, A | B>
346
- <K extends string | symbol, A, B>(self: ReadonlyRecord<K, A>, key: NoInfer<K>, f: (a: A) => B): Record<K, A | B>
347
- } = dual(
348
- 3,
349
- <K extends string | symbol, A, B>(self: ReadonlyRecord<K, A>, key: NoInfer<K>, f: (a: A) => B): Record<K, A | B> => {
350
- if (!has(self, key)) {
351
- return { ...self }
352
- }
353
- return { ...self, [key]: f(self[key]) }
354
- }
355
- )
356
-
357
- /**
358
- * Apply a function to the element at the specified key, creating a new record,
359
- * or return `None` if the key doesn't exist.
360
- *
361
- * @example
362
- * ```ts
363
- * import * as assert from "node:assert"
364
- * import { Record as R, Option } from "effect"
365
- *
366
- * const f = (x: number) => x * 2
367
- *
368
- * assert.deepStrictEqual(
369
- * R.modifyOption({ a: 3 }, 'a', f),
370
- * Option.some({ a: 6 })
371
- * )
372
- * assert.deepStrictEqual(
373
- * R.modifyOption({ a: 3 } as Record<string, number>, 'b', f),
374
- * Option.none()
375
- * )
376
- * ```
377
- *
378
- * @since 2.0.0
379
- */
380
- export const modifyOption: {
381
- <K extends string | symbol, A, B>(
382
- key: NoInfer<K>,
383
- f: (a: A) => B
384
- ): (self: ReadonlyRecord<K, A>) => Option.Option<Record<K, A | B>>
385
- <K extends string | symbol, A, B>(
386
- self: ReadonlyRecord<K, A>,
387
- key: NoInfer<K>,
388
- f: (a: A) => B
389
- ): Option.Option<Record<K, A | B>>
390
- } = dual(
391
- 3,
392
- <K extends string | symbol, A, B>(
393
- self: ReadonlyRecord<K, A>,
394
- key: NoInfer<K>,
395
- f: (a: A) => B
396
- ): Option.Option<Record<K, A | B>> => {
397
- if (!has(self, key)) {
398
- return Option.none()
399
- }
400
- return Option.some({ ...self, [key]: f(self[key]) })
401
- }
402
- )
403
-
404
- /**
405
- * Replaces a value in the record with the new value passed as parameter.
406
- *
407
- * @example
408
- * ```ts
409
- * import * as assert from "node:assert"
410
- * import { Record, Option } from "effect"
411
- *
412
- * assert.deepStrictEqual(
413
- * Record.replaceOption({ a: 1, b: 2, c: 3 }, 'a', 10),
414
- * Option.some({ a: 10, b: 2, c: 3 })
415
- * )
416
- * assert.deepStrictEqual(Record.replaceOption(Record.empty<string>(), 'a', 10), Option.none())
417
- * ```
418
- *
419
- * @since 2.0.0
420
- */
421
- export const replaceOption: {
422
- <K extends string | symbol, B>(
423
- key: NoInfer<K>,
424
- b: B
425
- ): <A>(self: ReadonlyRecord<K, A>) => Option.Option<Record<K, A | B>>
426
- <K extends string | symbol, A, B>(
427
- self: ReadonlyRecord<K, A>,
428
- key: NoInfer<K>,
429
- b: B
430
- ): Option.Option<Record<K, A | B>>
431
- } = dual(
432
- 3,
433
- <K extends string | symbol, A, B>(
434
- self: ReadonlyRecord<K, A>,
435
- key: NoInfer<K>,
436
- b: B
437
- ): Option.Option<Record<K, A | B>> => modifyOption(self, key, () => b)
438
- )
439
-
440
- /**
441
- * If the given key exists in the record, returns a new record with the key removed,
442
- * otherwise returns a copy of the original record.
443
- *
444
- * @example
445
- * ```ts
446
- * import * as assert from "node:assert"
447
- * import { remove } from "effect/Record"
448
- *
449
- * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 })
450
- * ```
451
- *
452
- * @since 2.0.0
453
- */
454
- export const remove: {
455
- <K extends string | symbol, X extends K>(key: X): <A>(self: ReadonlyRecord<K, A>) => Record<Exclude<K, X>, A>
456
- <K extends string | symbol, A, X extends K>(self: ReadonlyRecord<K, A>, key: X): Record<Exclude<K, X>, A>
457
- } = dual(
458
- 2,
459
- <K extends string | symbol, A, X extends K>(self: ReadonlyRecord<K, A>, key: X): Record<Exclude<K, X>, A> => {
460
- if (!has(self, key)) {
461
- return { ...self }
462
- }
463
- const out = { ...self }
464
- delete out[key]
465
- return out
466
- }
467
- )
468
-
469
- /**
470
- * Retrieves the value of the property with the given `key` from a record and returns an `Option`
471
- * of a tuple with the value and the record with the removed property.
472
- * If the key is not present, returns `O.none`.
473
- *
474
- * @example
475
- * ```ts
476
- * import * as assert from "node:assert"
477
- * import { Record as R, Option } from "effect"
478
- *
479
- * assert.deepStrictEqual(R.pop({ a: 1, b: 2 }, "a"), Option.some([1, { b: 2 }]))
480
- * assert.deepStrictEqual(R.pop({ a: 1, b: 2 } as Record<string, number>, "c"), Option.none())
481
- * ```
482
- *
483
- * @category record
484
- * @since 2.0.0
485
- */
486
- export const pop: {
487
- <K extends string | symbol, X extends K>(
488
- key: X
489
- ): <A>(self: ReadonlyRecord<K, A>) => Option.Option<[A, Record<Exclude<K, X>, A>]>
490
- <K extends string | symbol, A, X extends K>(
491
- self: ReadonlyRecord<K, A>,
492
- key: X
493
- ): Option.Option<[A, Record<Exclude<K, X>, A>]>
494
- } = dual(2, <K extends string | symbol, A, X extends K>(
495
- self: ReadonlyRecord<K, A>,
496
- key: X
497
- ): Option.Option<[A, Record<Exclude<K, X>, A>]> =>
498
- has(self, key) ? Option.some([self[key], remove(self, key)]) : Option.none())
499
-
500
- /**
501
- * Maps a record into another record by applying a transformation function to each of its values.
502
- *
503
- * @example
504
- * ```ts
505
- * import * as assert from "node:assert"
506
- * import { map } from "effect/Record"
507
- *
508
- * const f = (n: number) => `-${n}`
509
- *
510
- * assert.deepStrictEqual(map({ a: 3, b: 5 }, f), { a: "-3", b: "-5" })
511
- *
512
- * const g = (n: number, key: string) => `${key.toUpperCase()}-${n}`
513
- *
514
- * assert.deepStrictEqual(map({ a: 3, b: 5 }, g), { a: "A-3", b: "B-5" })
515
- * ```
516
- *
517
- * @category mapping
518
- * @since 2.0.0
519
- */
520
- export const map: {
521
- <K extends string, A, B>(f: (a: A, key: NoInfer<K>) => B): (self: ReadonlyRecord<K, A>) => Record<K, B>
522
- <K extends string, A, B>(self: ReadonlyRecord<K, A>, f: (a: A, key: NoInfer<K>) => B): Record<K, B>
523
- } = dual(
524
- 2,
525
- <K extends string, A, B>(self: ReadonlyRecord<K, A>, f: (a: A, key: NoInfer<K>) => B): Record<K, B> => {
526
- const out: Record<K, B> = { ...self } as any
527
- for (const key of keys(self)) {
528
- out[key] = f(self[key], key)
529
- }
530
- return out
531
- }
532
- )
533
-
534
- /**
535
- * Maps the keys of a `ReadonlyRecord` while preserving the corresponding values.
536
- *
537
- * @example
538
- * ```ts
539
- * import * as assert from "node:assert"
540
- * import { mapKeys } from "effect/Record"
541
- *
542
- * assert.deepStrictEqual(mapKeys({ a: 3, b: 5 }, (key) => key.toUpperCase()), { A: 3, B: 5 })
543
- * ```
544
- *
545
- * @category mapping
546
- * @since 2.0.0
547
- */
548
- export const mapKeys: {
549
- <K extends string, A, K2 extends string>(
550
- f: (key: K, a: A) => K2
551
- ): (self: ReadonlyRecord<K, A>) => Record<K2, A>
552
- <K extends string, A, K2 extends string>(
553
- self: ReadonlyRecord<K, A>,
554
- f: (key: K, a: A) => K2
555
- ): Record<K2, A>
556
- } = dual(
557
- 2,
558
- <K extends string, A, K2 extends string>(
559
- self: ReadonlyRecord<K, A>,
560
- f: (key: K, a: A) => K2
561
- ): Record<K2, A> => {
562
- const out: Record<K2, A> = {} as any
563
- for (const key of keys(self)) {
564
- const a = self[key]
565
- out[f(key, a)] = a
566
- }
567
- return out
568
- }
569
- )
570
-
571
- /**
572
- * Maps entries of a `ReadonlyRecord` using the provided function, allowing modification of both keys and corresponding values.
573
- *
574
- * @example
575
- * ```ts
576
- * import * as assert from "node:assert"
577
- * import { mapEntries } from "effect/Record"
578
- *
579
- * assert.deepStrictEqual(mapEntries({ a: 3, b: 5 }, (a, key) => [key.toUpperCase(), a + 1]), { A: 4, B: 6 })
580
- * ```
581
- *
582
- * @category mapping
583
- * @since 2.0.0
584
- */
585
- export const mapEntries: {
586
- <K extends string, A, K2 extends string, B>(
587
- f: (a: A, key: K) => readonly [K2, B]
588
- ): (self: ReadonlyRecord<K, A>) => Record<K2, B>
589
- <K extends string, A, K2 extends string, B>(
590
- self: ReadonlyRecord<K, A>,
591
- f: (a: A, key: K) => [K2, B]
592
- ): Record<K2, B>
593
- } = dual(
594
- 2,
595
- <K extends string, A, K2 extends string, B>(
596
- self: ReadonlyRecord<K, A>,
597
- f: (a: A, key: K) => [K2, B]
598
- ): Record<K2, B> => {
599
- const out = <Record<K2, B>> {}
600
- for (const key of keys(self)) {
601
- const [k, b] = f(self[key], key)
602
- out[k] = b
603
- }
604
- return out
605
- }
606
- )
607
-
608
- /**
609
- * Transforms a record into a record by applying the function `f` to each key and value in the original record.
610
- * If the function returns `Some`, the key-value pair is included in the output record.
611
- *
612
- * @example
613
- * ```ts
614
- * import * as assert from "node:assert"
615
- * import { Record, Option } from "effect"
616
- *
617
- * const x = { a: 1, b: 2, c: 3 }
618
- * const f = (a: number, key: string) => a > 2 ? Option.some(a * 2) : Option.none()
619
- * assert.deepStrictEqual(Record.filterMap(x, f), { c: 6 })
620
- * ```
621
- *
622
- * @since 2.0.0
623
- */
624
- export const filterMap: {
625
- <K extends string, A, B>(
626
- f: (a: A, key: K) => Option.Option<B>
627
- ): (self: ReadonlyRecord<K, A>) => Record<ReadonlyRecord.NonLiteralKey<K>, B>
628
- <K extends string, A, B>(
629
- self: ReadonlyRecord<K, A>,
630
- f: (a: A, key: K) => Option.Option<B>
631
- ): Record<ReadonlyRecord.NonLiteralKey<K>, B>
632
- } = dual(
633
- 2,
634
- <K extends string, A, B>(
635
- self: ReadonlyRecord<K, A>,
636
- f: (a: A, key: K) => Option.Option<B>
637
- ): Record<ReadonlyRecord.NonLiteralKey<K>, B> => {
638
- const out: Record<string, B> = empty()
639
- for (const key of keys(self)) {
640
- const o = f(self[key], key)
641
- if (Option.isSome(o)) {
642
- out[key] = o.value
643
- }
644
- }
645
- return out
646
- }
647
- )
648
-
649
- /**
650
- * Selects properties from a record whose values match the given predicate.
651
- *
652
- * @example
653
- * ```ts
654
- * import * as assert from "node:assert"
655
- * import { filter } from "effect/Record"
656
- *
657
- * const x = { a: 1, b: 2, c: 3, d: 4 }
658
- * assert.deepStrictEqual(filter(x, (n) => n > 2), { c: 3, d: 4 })
659
- * ```
660
- *
661
- * @category filtering
662
- * @since 2.0.0
663
- */
664
- export const filter: {
665
- <K extends string, A, B extends A>(
666
- refinement: (a: NoInfer<A>, key: K) => a is B
667
- ): (self: ReadonlyRecord<K, A>) => Record<ReadonlyRecord.NonLiteralKey<K>, B>
668
- <K extends string, A>(
669
- predicate: (A: NoInfer<A>, key: K) => boolean
670
- ): (self: ReadonlyRecord<K, A>) => Record<ReadonlyRecord.NonLiteralKey<K>, A>
671
- <K extends string, A, B extends A>(
672
- self: ReadonlyRecord<K, A>,
673
- refinement: (a: A, key: K) => a is B
674
- ): Record<ReadonlyRecord.NonLiteralKey<K>, B>
675
- <K extends string, A>(
676
- self: ReadonlyRecord<K, A>,
677
- predicate: (a: A, key: K) => boolean
678
- ): Record<ReadonlyRecord.NonLiteralKey<K>, A>
679
- } = dual(
680
- 2,
681
- <K extends string, A>(
682
- self: ReadonlyRecord<K, A>,
683
- predicate: (a: A, key: K) => boolean
684
- ): Record<ReadonlyRecord.NonLiteralKey<K>, A> => {
685
- const out: Record<string, A> = empty()
686
- for (const key of keys(self)) {
687
- if (predicate(self[key], key)) {
688
- out[key] = self[key]
689
- }
690
- }
691
- return out
692
- }
693
- )
694
-
695
- /**
696
- * Given a record with `Option` values, returns a new record containing only the `Some` values, preserving the original keys.
697
- *
698
- * @example
699
- * ```ts
700
- * import * as assert from "node:assert"
701
- * import { Record, Option } from "effect"
702
- *
703
- * assert.deepStrictEqual(
704
- * Record.getSomes({ a: Option.some(1), b: Option.none(), c: Option.some(2) }),
705
- * { a: 1, c: 2 }
706
- * )
707
- * ```
708
- *
709
- * @category filtering
710
- * @since 2.0.0
711
- */
712
- export const getSomes: <K extends string, A>(
713
- self: ReadonlyRecord<K, Option.Option<A>>
714
- ) => Record<ReadonlyRecord.NonLiteralKey<K>, A> = filterMap(
715
- identity
716
- )
717
-
718
- /**
719
- * Given a record with `Either` values, returns a new record containing only the `Left` values, preserving the original keys.
720
- *
721
- * @example
722
- * ```ts
723
- * import * as assert from "node:assert"
724
- * import { Record, Either } from "effect"
725
- *
726
- * assert.deepStrictEqual(
727
- * Record.getLefts({ a: Either.right(1), b: Either.left("err"), c: Either.right(2) }),
728
- * { b: "err" }
729
- * )
730
- * ```
731
- *
732
- * @category filtering
733
- * @since 2.0.0
734
- */
735
- export const getLefts = <K extends string, R, L>(
736
- self: ReadonlyRecord<K, Either<R, L>>
737
- ): Record<ReadonlyRecord.NonLiteralKey<K>, L> => {
738
- const out: Record<string, L> = empty()
739
- for (const key of keys(self)) {
740
- const value = self[key]
741
- if (E.isLeft(value)) {
742
- out[key] = value.left
743
- }
744
- }
745
-
746
- return out
747
- }
748
-
749
- /**
750
- * Given a record with `Either` values, returns a new record containing only the `Right` values, preserving the original keys.
751
- *
752
- * @example
753
- * ```ts
754
- * import * as assert from "node:assert"
755
- * import { Record, Either } from "effect"
756
- *
757
- * assert.deepStrictEqual(
758
- * Record.getRights({ a: Either.right(1), b: Either.left("err"), c: Either.right(2) }),
759
- * { a: 1, c: 2 }
760
- * )
761
- * ```
762
- *
763
- * @category filtering
764
- * @since 2.0.0
765
- */
766
- export const getRights = <K extends string, R, L>(
767
- self: ReadonlyRecord<K, Either<R, L>>
768
- ): Record<string, R> => {
769
- const out: Record<string, R> = empty()
770
- for (const key of keys(self)) {
771
- const value = self[key]
772
- if (E.isRight(value)) {
773
- out[key] = value.right
774
- }
775
- }
776
-
777
- return out
778
- }
779
-
780
- /**
781
- * Partitions the elements of a record into two groups: those that match a predicate, and those that don't.
782
- *
783
- * @example
784
- * ```ts
785
- * import * as assert from "node:assert"
786
- * import { Record, Either } from "effect"
787
- *
788
- * const x = { a: 1, b: 2, c: 3 }
789
- * const f = (n: number) => (n % 2 === 0 ? Either.right(n) : Either.left(n))
790
- * assert.deepStrictEqual(Record.partitionMap(x, f), [{ a: 1, c: 3 }, { b: 2}])
791
- * ```
792
- *
793
- * @category filtering
794
- * @since 2.0.0
795
- */
796
- export const partitionMap: {
797
- <K extends string, A, B, C>(
798
- f: (a: A, key: K) => Either<C, B>
799
- ): (
800
- self: ReadonlyRecord<K, A>
801
- ) => [left: Record<ReadonlyRecord.NonLiteralKey<K>, B>, right: Record<ReadonlyRecord.NonLiteralKey<K>, C>]
802
- <K extends string, A, B, C>(
803
- self: ReadonlyRecord<K, A>,
804
- f: (a: A, key: K) => Either<C, B>
805
- ): [left: Record<ReadonlyRecord.NonLiteralKey<K>, B>, right: Record<ReadonlyRecord.NonLiteralKey<K>, C>]
806
- } = dual(
807
- 2,
808
- <K extends string, A, B, C>(
809
- self: ReadonlyRecord<K, A>,
810
- f: (a: A, key: K) => Either<C, B>
811
- ): [left: Record<ReadonlyRecord.NonLiteralKey<K>, B>, right: Record<ReadonlyRecord.NonLiteralKey<K>, C>] => {
812
- const left: Record<string, B> = empty()
813
- const right: Record<string, C> = empty()
814
- for (const key of keys(self)) {
815
- const e = f(self[key], key)
816
- if (E.isLeft(e)) {
817
- left[key] = e.left
818
- } else {
819
- right[key] = e.right
820
- }
821
- }
822
- return [left, right]
823
- }
824
- )
825
-
826
- /**
827
- * Partitions a record of `Either` values into two separate records,
828
- * one with the `Left` values and one with the `Right` values.
829
- *
830
- * @example
831
- * ```ts
832
- * import * as assert from "node:assert"
833
- * import { Record, Either } from "effect"
834
- *
835
- * assert.deepStrictEqual(
836
- * Record.separate({ a: Either.left("e"), b: Either.right(1) }),
837
- * [{ a: "e" }, { b: 1 }]
838
- * )
839
- * ```
840
- *
841
- * @category filtering
842
- * @since 2.0.0
843
- */
844
- export const separate: <K extends string, A, B>(
845
- self: ReadonlyRecord<K, Either<B, A>>
846
- ) => [Record<ReadonlyRecord.NonLiteralKey<K>, A>, Record<ReadonlyRecord.NonLiteralKey<K>, B>] = partitionMap(identity)
847
-
848
- /**
849
- * Partitions a record into two separate records based on the result of a predicate function.
850
- *
851
- * @example
852
- * ```ts
853
- * import * as assert from "node:assert"
854
- * import { partition } from "effect/Record"
855
- *
856
- * assert.deepStrictEqual(
857
- * partition({ a: 1, b: 3 }, (n) => n > 2),
858
- * [{ a: 1 }, { b: 3 }]
859
- * )
860
- * ```
861
- *
862
- * @category filtering
863
- * @since 2.0.0
864
- */
865
- export const partition: {
866
- <K extends string, A, B extends A>(refinement: (a: NoInfer<A>, key: K) => a is B): (
867
- self: ReadonlyRecord<K, A>
868
- ) => [
869
- excluded: Record<ReadonlyRecord.NonLiteralKey<K>, Exclude<A, B>>,
870
- satisfying: Record<ReadonlyRecord.NonLiteralKey<K>, B>
871
- ]
872
- <K extends string, A>(
873
- predicate: (a: NoInfer<A>, key: K) => boolean
874
- ): (
875
- self: ReadonlyRecord<K, A>
876
- ) => [excluded: Record<ReadonlyRecord.NonLiteralKey<K>, A>, satisfying: Record<ReadonlyRecord.NonLiteralKey<K>, A>]
877
- <K extends string, A, B extends A>(
878
- self: ReadonlyRecord<K, A>,
879
- refinement: (a: A, key: K) => a is B
880
- ): [
881
- excluded: Record<ReadonlyRecord.NonLiteralKey<K>, Exclude<A, B>>,
882
- satisfying: Record<ReadonlyRecord.NonLiteralKey<K>, B>
883
- ]
884
- <K extends string, A>(
885
- self: ReadonlyRecord<K, A>,
886
- predicate: (a: A, key: K) => boolean
887
- ): [excluded: Record<ReadonlyRecord.NonLiteralKey<K>, A>, satisfying: Record<ReadonlyRecord.NonLiteralKey<K>, A>]
888
- } = dual(
889
- 2,
890
- <K extends string, A>(
891
- self: ReadonlyRecord<K, A>,
892
- predicate: (a: A, key: K) => boolean
893
- ): [excluded: Record<ReadonlyRecord.NonLiteralKey<K>, A>, satisfying: Record<ReadonlyRecord.NonLiteralKey<K>, A>] => {
894
- const left: Record<string, A> = empty()
895
- const right: Record<string, A> = empty()
896
- for (const key of keys(self)) {
897
- if (predicate(self[key], key)) {
898
- right[key] = self[key]
899
- } else {
900
- left[key] = self[key]
901
- }
902
- }
903
- return [left, right]
904
- }
905
- )
906
-
907
- /**
908
- * Retrieve the keys of a given record as an array.
909
- *
910
- * @since 2.0.0
911
- */
912
- export const keys = <K extends string | symbol, A>(self: ReadonlyRecord<K, A>): Array<K & string> =>
913
- Object.keys(self) as Array<K & string>
914
-
915
- /**
916
- * Retrieve the values of a given record as an array.
917
- *
918
- * @since 2.0.0
919
- */
920
- export const values = <K extends string, A>(self: ReadonlyRecord<K, A>): Array<A> => collect(self, (_, a) => a)
921
-
922
- /**
923
- * Add a new key-value pair or update an existing key's value in a record.
924
- *
925
- * @example
926
- * ```ts
927
- * import * as assert from "node:assert"
928
- * import { set } from "effect/Record"
929
- *
930
- * assert.deepStrictEqual(set("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
931
- * assert.deepStrictEqual(set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 });
932
- * ```
933
- *
934
- * @since 2.0.0
935
- */
936
- export const set: {
937
- <K extends string | symbol, K1 extends K | ((string | symbol) & {}), B>(
938
- key: K1,
939
- value: B
940
- ): <A>(self: ReadonlyRecord<K, A>) => Record<K | K1, A | B>
941
- <K extends string | symbol, A, K1 extends K | ((string | symbol) & {}), B>(
942
- self: ReadonlyRecord<K, A>,
943
- key: K1,
944
- value: B
945
- ): Record<K | K1, A | B>
946
- } = dual(
947
- 3,
948
- <K extends string | symbol, A, K1 extends K | ((string | symbol) & {}), B>(
949
- self: ReadonlyRecord<K, A>,
950
- key: K1,
951
- value: B
952
- ): Record<K | K1, A | B> => {
953
- return { ...self, [key]: value } as any
954
- }
955
- )
956
-
957
- /**
958
- * Replace a key's value in a record and return the updated record.
959
- * If the key does not exist in the record, a copy of the original record is returned.
960
- *
961
- * @example
962
- * ```ts
963
- * import * as assert from "node:assert"
964
- * import { Record } from "effect"
965
- *
966
- * assert.deepStrictEqual(Record.replace("a", 3)({ a: 1, b: 2 }), { a: 3, b: 2 });
967
- * assert.deepStrictEqual(Record.replace("c", 3)({ a: 1, b: 2 }), { a: 1, b: 2 });
968
- * ```
969
- *
970
- * @since 2.0.0
971
- */
972
- export const replace: {
973
- <K extends string | symbol, B>(key: NoInfer<K>, value: B): <A>(self: ReadonlyRecord<K, A>) => Record<K, A | B>
974
- <K extends string | symbol, A, B>(self: ReadonlyRecord<K, A>, key: NoInfer<K>, value: B): Record<K, A | B>
975
- } = dual(
976
- 3,
977
- <K extends string | symbol, A, B>(self: ReadonlyRecord<K, A>, key: NoInfer<K>, value: B): Record<K, A | B> => {
978
- if (has(self, key)) {
979
- return { ...self, [key]: value }
980
- }
981
- return { ...self }
982
- }
983
- )
984
-
985
- /**
986
- * Check if all the keys and values in one record are also found in another record.
987
- *
988
- * @since 2.0.0
989
- */
990
- export const isSubrecordBy = <A>(equivalence: Equivalence<A>): {
991
- <K extends string>(that: ReadonlyRecord<K, A>): (self: ReadonlyRecord<K, A>) => boolean
992
- <K extends string>(self: ReadonlyRecord<K, A>, that: ReadonlyRecord<K, A>): boolean
993
- } =>
994
- dual(2, <K extends string>(self: ReadonlyRecord<K, A>, that: ReadonlyRecord<K, A>): boolean => {
995
- for (const key of keys(self)) {
996
- if (!has(that, key) || !equivalence(self[key], that[key])) {
997
- return false
998
- }
999
- }
1000
- return true
1001
- })
1002
-
1003
- /**
1004
- * Check if one record is a subrecord of another, meaning it contains all the keys and values found in the second record.
1005
- * This comparison uses default equality checks (`Equal.equivalence()`).
1006
- *
1007
- * @since 2.0.0
1008
- */
1009
- export const isSubrecord: {
1010
- <K extends string, A>(that: ReadonlyRecord<K, A>): (self: ReadonlyRecord<K, A>) => boolean
1011
- <K extends string, A>(self: ReadonlyRecord<K, A>, that: ReadonlyRecord<K, A>): boolean
1012
- } = isSubrecordBy(Equal.equivalence())
1013
-
1014
- /**
1015
- * Reduce a record to a single value by combining its entries with a specified function.
1016
- *
1017
- * @category folding
1018
- * @since 2.0.0
1019
- */
1020
- export const reduce: {
1021
- <Z, V, K extends string>(
1022
- zero: Z,
1023
- f: (accumulator: Z, value: V, key: K) => Z
1024
- ): (self: ReadonlyRecord<K, V>) => Z
1025
- <K extends string, V, Z>(self: ReadonlyRecord<K, V>, zero: Z, f: (accumulator: Z, value: V, key: K) => Z): Z
1026
- } = dual(
1027
- 3,
1028
- <K extends string, V, Z>(
1029
- self: ReadonlyRecord<K, V>,
1030
- zero: Z,
1031
- f: (accumulator: Z, value: V, key: K) => Z
1032
- ): Z => {
1033
- let out: Z = zero
1034
- for (const key of keys(self)) {
1035
- out = f(out, self[key], key)
1036
- }
1037
- return out
1038
- }
1039
- )
1040
-
1041
- /**
1042
- * Check if all entries in a record meet a specific condition.
1043
- *
1044
- * @since 2.0.0
1045
- */
1046
- export const every: {
1047
- <A, K extends string, B extends A>(
1048
- refinement: (value: A, key: K) => value is B
1049
- ): (self: ReadonlyRecord<K, A>) => self is ReadonlyRecord<K, B>
1050
- <A, K extends string>(predicate: (value: A, key: K) => boolean): (self: ReadonlyRecord<K, A>) => boolean
1051
- <A, K extends string, B extends A>(
1052
- self: ReadonlyRecord<K, A>,
1053
- refinement: (value: A, key: K) => value is B
1054
- ): self is ReadonlyRecord<K, B>
1055
- <K extends string, A>(self: ReadonlyRecord<K, A>, predicate: (value: A, key: K) => boolean): boolean
1056
- } = dual(
1057
- 2,
1058
- <A, K extends string, B extends A>(
1059
- self: ReadonlyRecord<K, A>,
1060
- refinement: (value: A, key: K) => value is B
1061
- ): self is ReadonlyRecord<K, B> => {
1062
- for (const key of keys(self)) {
1063
- if (!refinement(self[key], key)) {
1064
- return false
1065
- }
1066
- }
1067
- return true
1068
- }
1069
- )
1070
-
1071
- /**
1072
- * Check if any entry in a record meets a specific condition.
1073
- *
1074
- * @since 2.0.0
1075
- */
1076
- export const some: {
1077
- <A, K extends string>(predicate: (value: A, key: K) => boolean): (self: ReadonlyRecord<K, A>) => boolean
1078
- <K extends string, A>(self: ReadonlyRecord<K, A>, predicate: (value: A, key: K) => boolean): boolean
1079
- } = dual(
1080
- 2,
1081
- <K extends string, A>(self: ReadonlyRecord<K, A>, predicate: (value: A, key: K) => boolean): boolean => {
1082
- for (const key of keys(self)) {
1083
- if (predicate(self[key], key)) {
1084
- return true
1085
- }
1086
- }
1087
- return false
1088
- }
1089
- )
1090
-
1091
- /**
1092
- * Merge two records, preserving entries that exist in either of the records.
1093
- *
1094
- * @since 2.0.0
1095
- */
1096
- export const union: {
1097
- <K1 extends string, A, B, C>(
1098
- that: ReadonlyRecord<K1, B>,
1099
- combine: (selfValue: A, thatValue: B) => C
1100
- ): <K0 extends string>(self: ReadonlyRecord<K0, A>) => Record<K0 | K1, A | B | C>
1101
- <K0 extends string, A, K1 extends string, B, C>(
1102
- self: ReadonlyRecord<K0, A>,
1103
- that: ReadonlyRecord<K1, B>,
1104
- combine: (selfValue: A, thatValue: B) => C
1105
- ): Record<K0 | K1, A | B | C>
1106
- } = dual(
1107
- 3,
1108
- <K0 extends string, A, K1 extends string, B, C>(
1109
- self: ReadonlyRecord<K0, A>,
1110
- that: ReadonlyRecord<K1, B>,
1111
- combine: (selfValue: A, thatValue: B) => C
1112
- ): Record<K0 | K1, A | B | C> => {
1113
- if (isEmptyRecord(self)) {
1114
- return { ...that } as any
1115
- }
1116
- if (isEmptyRecord(that)) {
1117
- return { ...self } as any
1118
- }
1119
- const out: Record<string, A | B | C> = empty()
1120
- for (const key of keys(self)) {
1121
- if (has(that, key as any)) {
1122
- out[key] = combine(self[key], that[key as unknown as K1])
1123
- } else {
1124
- out[key] = self[key]
1125
- }
1126
- }
1127
- for (const key of keys(that)) {
1128
- if (!has(out, key)) {
1129
- out[key] = that[key]
1130
- }
1131
- }
1132
- return out
1133
- }
1134
- )
1135
-
1136
- /**
1137
- * Merge two records, retaining only the entries that exist in both records.
1138
- *
1139
- * @since 2.0.0
1140
- */
1141
- export const intersection: {
1142
- <K1 extends string, A, B, C>(
1143
- that: ReadonlyRecord<K1, B>,
1144
- combine: (selfValue: A, thatValue: B) => C
1145
- ): <K0 extends string>(self: ReadonlyRecord<K0, A>) => Record<ReadonlyRecord.IntersectKeys<K0, K1>, C>
1146
- <K0 extends string, A, K1 extends string, B, C>(
1147
- self: ReadonlyRecord<K0, A>,
1148
- that: ReadonlyRecord<K1, B>,
1149
- combine: (selfValue: A, thatValue: B) => C
1150
- ): Record<ReadonlyRecord.IntersectKeys<K0, K1>, C>
1151
- } = dual(
1152
- 3,
1153
- <K0 extends string, A, K1 extends string, B, C>(
1154
- self: ReadonlyRecord<K0, A>,
1155
- that: ReadonlyRecord<K1, B>,
1156
- combine: (selfValue: A, thatValue: B) => C
1157
- ): Record<ReadonlyRecord.IntersectKeys<K0, K1>, C> => {
1158
- const out: Record<string, C> = empty()
1159
- if (isEmptyRecord(self) || isEmptyRecord(that)) {
1160
- return out
1161
- }
1162
- for (const key of keys(self)) {
1163
- if (has(that, key as any)) {
1164
- out[key] = combine(self[key], that[key as unknown as K1])
1165
- }
1166
- }
1167
- return out
1168
- }
1169
- )
1170
-
1171
- /**
1172
- * Merge two records, preserving only the entries that are unique to each record.
1173
- *
1174
- * @since 2.0.0
1175
- */
1176
- export const difference: {
1177
- <K1 extends string, B>(
1178
- that: ReadonlyRecord<K1, B>
1179
- ): <K0 extends string, A>(self: ReadonlyRecord<K0, A>) => Record<K0 | K1, A | B>
1180
- <K0 extends string, A, K1 extends string, B>(
1181
- self: ReadonlyRecord<K0, A>,
1182
- that: ReadonlyRecord<K1, B>
1183
- ): Record<K0 | K1, A | B>
1184
- } = dual(2, <K0 extends string, A, K1 extends string, B>(
1185
- self: ReadonlyRecord<K0, A>,
1186
- that: ReadonlyRecord<K1, B>
1187
- ): Record<K0 | K1, A | B> => {
1188
- if (isEmptyRecord(self)) {
1189
- return { ...that } as any
1190
- }
1191
- if (isEmptyRecord(that)) {
1192
- return { ...self } as any
1193
- }
1194
- const out = <Record<K0 | K1, A | B>> {}
1195
- for (const key of keys(self)) {
1196
- if (!has(that, key as any)) {
1197
- out[key] = self[key]
1198
- }
1199
- }
1200
- for (const key of keys(that)) {
1201
- if (!has(self, key as any)) {
1202
- out[key] = that[key]
1203
- }
1204
- }
1205
- return out
1206
- })
1207
-
1208
- /**
1209
- * Create an `Equivalence` for records using the provided `Equivalence` for values.
1210
- *
1211
- * @category instances
1212
- * @since 2.0.0
1213
- */
1214
- export const getEquivalence = <K extends string, A>(
1215
- equivalence: Equivalence<A>
1216
- ): Equivalence<ReadonlyRecord<K, A>> => {
1217
- const is = isSubrecordBy(equivalence)
1218
- return (self, that) => is(self, that) && is(that, self)
1219
- }
1220
-
1221
- /**
1222
- * Create a non-empty record from a single element.
1223
- *
1224
- * @category constructors
1225
- * @since 2.0.0
1226
- */
1227
- export const singleton = <K extends string | symbol, A>(key: K, value: A): Record<K, A> => ({
1228
- [key]: value
1229
- } as any)
1230
-
1231
- /**
1232
- * Returns the first entry that satisfies the specified
1233
- * predicate, or `None` if no such entry exists.
1234
- *
1235
- * @example
1236
- * ```ts
1237
- * import { Record, Option } from "effect"
1238
- *
1239
- * const record = { a: 1, b: 2, c: 3 }
1240
- * const result = Record.findFirst(record, (value, key) => value > 1 && key !== "b")
1241
- * console.log(result) // Option.Some(["c", 3])
1242
- * ```
1243
- *
1244
- * @category elements
1245
- * @since 3.14.0
1246
- */
1247
- export const findFirst: {
1248
- <K extends string | symbol, V, V2 extends V>(
1249
- refinement: (value: NoInfer<V>, key: NoInfer<K>) => value is V2
1250
- ): (self: ReadonlyRecord<K, V>) => Option.Option<[K, V2]>
1251
- <K extends string | symbol, V>(
1252
- predicate: (value: NoInfer<V>, key: NoInfer<K>) => boolean
1253
- ): (self: ReadonlyRecord<K, V>) => Option.Option<[K, V]>
1254
- <K extends string | symbol, V, V2 extends V>(
1255
- self: ReadonlyRecord<K, V>,
1256
- refinement: (value: NoInfer<V>, key: NoInfer<K>) => value is V2
1257
- ): Option.Option<[K, V2]>
1258
- <K extends string | symbol, V>(
1259
- self: ReadonlyRecord<K, V>,
1260
- predicate: (value: NoInfer<V>, key: NoInfer<K>) => boolean
1261
- ): Option.Option<[K, V]>
1262
- } = dual(
1263
- 2,
1264
- <K extends string | symbol, V>(self: ReadonlyRecord<K, V>, f: (value: V, key: K) => boolean) => {
1265
- const k = keys(self)
1266
- for (let i = 0; i < k.length; i++) {
1267
- const key = k[i]
1268
- if (f(self[key], key)) {
1269
- return Option.some([key, self[key]])
1270
- }
1271
- }
1272
- return Option.none()
1273
- }
1274
- )