add PrimaryKey module (#1669)

Effect-TS · Nov 20, 2023 · 541330b · 541330b
1 parent c687a87
commit 541330b
Show file tree

Hide file tree

Showing 71 changed files with 152 additions and 66 deletions.
diff --git a/.changeset/fast-nails-swim.md b/.changeset/fast-nails-swim.md
@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+add PrimaryKey module
diff --git a/docs/modules/PrimaryKey.ts.md b/docs/modules/PrimaryKey.ts.md
@@ -0,0 +1,46 @@
+---
+title: PrimaryKey.ts
+nav_order: 79
+parent: Modules
+---
+
+## PrimaryKey overview
+
+Added in v2.0.0
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [models](#models)
+  - [PrimaryKey (interface)](#primarykey-interface)
+- [symbols](#symbols)
+  - [symbol](#symbol)
+
+---
+
+# models
+
+## PrimaryKey (interface)
+
+**Signature**
+
+```ts
+export interface PrimaryKey {
+  [symbol](): string
+}
+```
+
+Added in v2.0.0
+
+# symbols
+
+## symbol
+
+**Signature**
+
+```ts
+export declare const symbol: typeof symbol
+```
+
+Added in v2.0.0
diff --git a/docs/modules/PubSub.ts.md b/docs/modules/PubSub.ts.md
@@ -1,6 +1,6 @@
 ---
 title: PubSub.ts
-nav_order: 79
+nav_order: 80
 parent: Modules
 ---
 

diff --git a/docs/modules/Queue.ts.md b/docs/modules/Queue.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Queue.ts
-nav_order: 80
+nav_order: 81
 parent: Modules
 ---
 

diff --git a/docs/modules/Random.ts.md b/docs/modules/Random.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Random.ts
-nav_order: 81
+nav_order: 82
 parent: Modules
 ---
 

diff --git a/docs/modules/ReadonlyArray.ts.md b/docs/modules/ReadonlyArray.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ReadonlyArray.ts
-nav_order: 82
+nav_order: 83
 parent: Modules
 ---
 

diff --git a/docs/modules/ReadonlyRecord.ts.md b/docs/modules/ReadonlyRecord.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ReadonlyRecord.ts
-nav_order: 83
+nav_order: 84
 parent: Modules
 ---
 

diff --git a/docs/modules/RedBlackTree.ts.md b/docs/modules/RedBlackTree.ts.md
@@ -1,6 +1,6 @@
 ---
 title: RedBlackTree.ts
-nav_order: 84
+nav_order: 85
 parent: Modules
 ---
 

diff --git a/docs/modules/Ref.ts.md b/docs/modules/Ref.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Ref.ts
-nav_order: 85
+nav_order: 86
 parent: Modules
 ---
 

diff --git a/docs/modules/Reloadable.ts.md b/docs/modules/Reloadable.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Reloadable.ts
-nav_order: 86
+nav_order: 87
 parent: Modules
 ---
 

diff --git a/docs/modules/Request.ts.md b/docs/modules/Request.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Request.ts
-nav_order: 87
+nav_order: 88
 parent: Modules
 ---
 

diff --git a/docs/modules/RequestBlock.ts.md b/docs/modules/RequestBlock.ts.md
@@ -1,6 +1,6 @@
 ---
 title: RequestBlock.ts
-nav_order: 88
+nav_order: 89
 parent: Modules
 ---
 

diff --git a/docs/modules/RequestResolver.ts.md b/docs/modules/RequestResolver.ts.md
@@ -1,6 +1,6 @@
 ---
 title: RequestResolver.ts
-nav_order: 89
+nav_order: 90
 parent: Modules
 ---
 

diff --git a/docs/modules/Resource.ts.md b/docs/modules/Resource.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Resource.ts
-nav_order: 90
+nav_order: 91
 parent: Modules
 ---
 

diff --git a/docs/modules/Runtime.ts.md b/docs/modules/Runtime.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Runtime.ts
-nav_order: 91
+nav_order: 92
 parent: Modules
 ---
 

diff --git a/docs/modules/RuntimeFlags.ts.md b/docs/modules/RuntimeFlags.ts.md
@@ -1,6 +1,6 @@
 ---
 title: RuntimeFlags.ts
-nav_order: 92
+nav_order: 93
 parent: Modules
 ---
 

diff --git a/docs/modules/RuntimeFlagsPatch.ts.md b/docs/modules/RuntimeFlagsPatch.ts.md
@@ -1,6 +1,6 @@
 ---
 title: RuntimeFlagsPatch.ts
-nav_order: 93
+nav_order: 94
 parent: Modules
 ---
 

diff --git a/docs/modules/STM.ts.md b/docs/modules/STM.ts.md
@@ -1,6 +1,6 @@
 ---
 title: STM.ts
-nav_order: 106
+nav_order: 107
 parent: Modules
 ---
 

diff --git a/docs/modules/Schedule.ts.md b/docs/modules/Schedule.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Schedule.ts
-nav_order: 94
+nav_order: 95
 parent: Modules
 ---
 

diff --git a/docs/modules/ScheduleDecision.ts.md b/docs/modules/ScheduleDecision.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ScheduleDecision.ts
-nav_order: 95
+nav_order: 96
 parent: Modules
 ---
 

diff --git a/docs/modules/ScheduleInterval.ts.md b/docs/modules/ScheduleInterval.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ScheduleInterval.ts
-nav_order: 96
+nav_order: 97
 parent: Modules
 ---
 

diff --git a/docs/modules/ScheduleIntervals.ts.md b/docs/modules/ScheduleIntervals.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ScheduleIntervals.ts
-nav_order: 97
+nav_order: 98
 parent: Modules
 ---
 

diff --git a/docs/modules/Scheduler.ts.md b/docs/modules/Scheduler.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Scheduler.ts
-nav_order: 98
+nav_order: 99
 parent: Modules
 ---
 

diff --git a/docs/modules/Scope.ts.md b/docs/modules/Scope.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Scope.ts
-nav_order: 99
+nav_order: 100
 parent: Modules
 ---
 

diff --git a/docs/modules/ScopedCache.ts.md b/docs/modules/ScopedCache.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ScopedCache.ts
-nav_order: 100
+nav_order: 101
 parent: Modules
 ---
 

diff --git a/docs/modules/ScopedRef.ts.md b/docs/modules/ScopedRef.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ScopedRef.ts
-nav_order: 101
+nav_order: 102
 parent: Modules
 ---
 

diff --git a/docs/modules/SingleProducerAsyncInput.ts.md b/docs/modules/SingleProducerAsyncInput.ts.md
@@ -1,6 +1,6 @@
 ---
 title: SingleProducerAsyncInput.ts
-nav_order: 102
+nav_order: 103
 parent: Modules
 ---
 

diff --git a/docs/modules/Sink.ts.md b/docs/modules/Sink.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Sink.ts
-nav_order: 103
+nav_order: 104
 parent: Modules
 ---
 

diff --git a/docs/modules/SortedMap.ts.md b/docs/modules/SortedMap.ts.md
@@ -1,6 +1,6 @@
 ---
 title: SortedMap.ts
-nav_order: 104
+nav_order: 105
 parent: Modules
 ---
 

diff --git a/docs/modules/SortedSet.ts.md b/docs/modules/SortedSet.ts.md
@@ -1,6 +1,6 @@
 ---
 title: SortedSet.ts
-nav_order: 105
+nav_order: 106
 parent: Modules
 ---
 

diff --git a/docs/modules/Stream.ts.md b/docs/modules/Stream.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Stream.ts
-nav_order: 107
+nav_order: 108
 parent: Modules
 ---
 

diff --git a/docs/modules/StreamEmit.ts.md b/docs/modules/StreamEmit.ts.md
@@ -1,6 +1,6 @@
 ---
 title: StreamEmit.ts
-nav_order: 109
+nav_order: 110
 parent: Modules
 ---
 

diff --git a/docs/modules/StreamHaltStrategy.ts.md b/docs/modules/StreamHaltStrategy.ts.md
@@ -1,6 +1,6 @@
 ---
 title: StreamHaltStrategy.ts
-nav_order: 110
+nav_order: 111
 parent: Modules
 ---
 

diff --git a/docs/modules/Streamable.ts.md b/docs/modules/Streamable.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Streamable.ts
-nav_order: 108
+nav_order: 109
 parent: Modules
 ---
 

diff --git a/docs/modules/String.ts.md b/docs/modules/String.ts.md
@@ -1,6 +1,6 @@
 ---
 title: String.ts
-nav_order: 111
+nav_order: 112
 parent: Modules
 ---
 

diff --git a/docs/modules/Struct.ts.md b/docs/modules/Struct.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Struct.ts
-nav_order: 112
+nav_order: 113
 parent: Modules
 ---
 

diff --git a/docs/modules/SubscriptionRef.ts.md b/docs/modules/SubscriptionRef.ts.md
@@ -1,6 +1,6 @@
 ---
 title: SubscriptionRef.ts
-nav_order: 113
+nav_order: 114
 parent: Modules
 ---
 

diff --git a/docs/modules/Supervisor.ts.md b/docs/modules/Supervisor.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Supervisor.ts
-nav_order: 114
+nav_order: 115
 parent: Modules
 ---
 

diff --git a/docs/modules/Symbol.ts.md b/docs/modules/Symbol.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Symbol.ts
-nav_order: 115
+nav_order: 116
 parent: Modules
 ---
 

diff --git a/docs/modules/SynchronizedRef.ts.md b/docs/modules/SynchronizedRef.ts.md
@@ -1,6 +1,6 @@
 ---
 title: SynchronizedRef.ts
-nav_order: 116
+nav_order: 117
 parent: Modules
 ---
 

diff --git a/docs/modules/TArray.ts.md b/docs/modules/TArray.ts.md
@@ -1,6 +1,6 @@
 ---
 title: TArray.ts
-nav_order: 118
+nav_order: 119
 parent: Modules
 ---
 

diff --git a/docs/modules/TDeferred.ts.md b/docs/modules/TDeferred.ts.md
@@ -1,6 +1,6 @@
 ---
 title: TDeferred.ts
-nav_order: 119
+nav_order: 120
 parent: Modules
 ---
 

diff --git a/docs/modules/TMap.ts.md b/docs/modules/TMap.ts.md
@@ -1,6 +1,6 @@
 ---
 title: TMap.ts
-nav_order: 129
+nav_order: 130
 parent: Modules
 ---
 

diff --git a/docs/modules/TPriorityQueue.ts.md b/docs/modules/TPriorityQueue.ts.md
@@ -1,6 +1,6 @@
 ---
 title: TPriorityQueue.ts
-nav_order: 130
+nav_order: 131
 parent: Modules
 ---
 

diff --git a/docs/modules/TPubSub.ts.md b/docs/modules/TPubSub.ts.md
@@ -1,6 +1,6 @@
 ---
 title: TPubSub.ts
-nav_order: 131
+nav_order: 132
 parent: Modules
 ---