Merge pull request #164 from Kevin-Lee/docs/either-isLeft

Update: docs - `either.md`: add `isLeft`
kevin-lee · Dec 30, 2021 · 8ab576b · 8ab576b
2 parents 8496d90 + 4a342e3
commit 8ab576b
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/website/docs/types/either.md b/website/docs/types/either.md
@@ -300,6 +300,22 @@ errorMsgOrNum2.isRight();
 ```
 
 ### `Either.isLeft`
+To check if the `Either` is `Left`, use `isLeft()`,
+```java
+import j8plus.types.Either;
+
+final Either<String, Integer> errorMsgOrNum = Either.right(999);
+// Either<String, Integer> = Right(999)
+
+errorMsgOrNum.isLeft();
+// boolean = false
+
+final Either<String, Integer> errorMsgOrNum2 = Either.left("Error message");
+// Either<String, Integer> = Left(Error message)
+
+errorMsgOrNum2.isLeft();
+// boolean = true
+```
 
 
 ### Example