Expose Schedule.isSchedule (#4344)

Effect-TS · Jan 28, 2025 · 7b03057 · 7b03057
1 parent 62934fc
commit 7b03057
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/.changeset/shy-nails-happen.md b/.changeset/shy-nails-happen.md
@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+Expose `Schedule.isSchedule`
diff --git a/packages/effect/src/Schedule.ts b/packages/effect/src/Schedule.ts
@@ -140,6 +140,14 @@ export const makeWithState: <S, In, Out, R = never>(
   ) => Effect.Effect<readonly [S, Out, ScheduleDecision.ScheduleDecision], never, R>
 ) => Schedule<Out, In, R> = internal.makeWithState
 
+/**
+ * Returns `true` if the specified value is a `Schedule`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category guards
+ */
+export const isSchedule: (u: unknown) => u is Schedule<unknown, never, unknown> = internal.isSchedule
+
 /**
  * Returns a new schedule with the given delay added to every interval defined
  * by this schedule.

diff --git a/packages/effect/src/internal/schedule.ts b/packages/effect/src/internal/schedule.ts
@@ -34,7 +34,8 @@ export const ScheduleTypeId: Schedule.ScheduleTypeId = Symbol.for(
 ) as Schedule.ScheduleTypeId
 
 /** @internal */
-export const isSchedule = (u: unknown): u is Schedule.Schedule<any, any, any> => hasProperty(u, ScheduleTypeId)
+export const isSchedule = (u: unknown): u is Schedule.Schedule<unknown, never, unknown> =>
+  hasProperty(u, ScheduleTypeId)
 
 /** @internal */
 const ScheduleDriverSymbolKey = "effect/ScheduleDriver"