feat: Add Pure alias for True (#149)

Iltotore · Jun 30, 2023 · da8629d · da8629d
1 parent 022d3f4
commit da8629d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/_docs/reference/newtypes.md b/docs/_docs/reference/newtypes.md
@@ -94,3 +94,12 @@ val unsafeRuntime: Double =
   else throw new IllegalArgumentException("...")
 ```
 
+## New type with no constraint
+
+You can create a new type without restriction by using the [[Pure|io.github.iltotore.iron.constraint.any.Pure]]
+constraint. [[Pure|io.github.iltotore.iron.constraint.any.Pure]] is an alias for
+[[True|io.github.iltotore.iron.constraint.any.True]], a constraint that is always satisfied.
+
+```scala
+type FirstName = String :| Pure
+```
diff --git a/main/src/io/github/iltotore/iron/constraint/any.scala b/main/src/io/github/iltotore/iron/constraint/any.scala
@@ -18,6 +18,12 @@ object any:
    */
   final class True
 
+  /**
+   * Alias for [[True]]. Usually used for new types with no constraint.
+   * @see "Creating new types" reference.
+   */
+  type Pure = True
+
   /**
    * An always-invalid constraint.
    */