docs(optional): deprecate the cast method

dancrumb · Jul 31, 2024 · 2e2a844 · 2e2a844
1 parent fa0b39a
commit 2e2a844
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/Optional.ts b/src/Optional.ts
@@ -221,6 +221,8 @@ export class Optional<T> {
    * type checking. This is generally used for up- and down-casting.
    *
    * @param guard
+   * 
+   * @deprecated just use `filter` with a type guard
    */
   cast<S extends T>(guard: (o: T | S) => boolean): Optional<S> {
     if (this.isPresent() && guard(this.get())) {