effect 4.0.0-beta.70 → 4.0.0-beta.72

package/dist/Cron.d.ts

@@ -9,6 +9,11 @@ declare const TypeId = "~effect/time/Cron";
 /**
  * Represents a cron schedule with time constraints and timezone information.
  *
+ * **When to use**
+ *
+ * Use to represent a recurring calendar schedule that can be matched against
+ * dates or used to compute scheduled occurrences.
+ *
  * **Details**
  *
  * A `Cron` instance defines when a scheduled task should run, supporting
@@ -66,6 +71,11 @@ declare const TypeId = "~effect/time/Cron";
  * console.log(matches) // true if it's 9 AM on a weekday
  * ```
  *
+ * @see {@link make} for creating a schedule from explicit field constraints
+ * @see {@link parse} for creating a schedule from a cron expression string
+ * @see {@link match} for testing a date against a schedule
+ * @see {@link next} for finding the next scheduled occurrence
+ *
  * @category models
  * @since 2.0.0
  */
@@ -80,7 +90,11 @@ export interface Cron extends Pipeable, Equal.Equal, Inspectable {
     readonly weekdays: ReadonlySet<number>;
 }
 /**
- * Checks if a given value is a Cron instance.
+ * Checks whether a given value is a Cron instance.
+ *
+ * **When to use**
+ *
+ * Use to narrow an unknown value before treating it as a `Cron` schedule.
  *
  * **Details**
  *
@@ -106,6 +120,9 @@ export interface Cron extends Pipeable, Equal.Equal, Inspectable {
  * console.log(Cron.isCron("not a cron")) // false
  * ```
  *
+ * @see {@link make} for constructing a `Cron` value directly
+ * @see {@link parse} for constructing a `Cron` value from a string
+ *
  * @category guards
  * @since 2.0.0
  */
@@ -113,6 +130,10 @@ export declare const isCron: (u: unknown) => u is Cron;
 /**
  * Creates a Cron instance from time constraints.
  *
+ * **When to use**
+ *
+ * Use to build a cron schedule from explicit sets of allowed time-field values.
+ *
  * **Details**
  *
  * Constructs a cron schedule by specifying which seconds, minutes, hours,
@@ -207,6 +228,8 @@ export declare const isCron: (u: unknown) => u is Cron;
  * })
  * ```
  *
+ * @see {@link parse} for building a schedule from a cron expression string
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -226,6 +249,10 @@ declare const CronParseError_base: new <A extends Record<string, any> = {}>(args
 /**
  * Represents an error that occurs when parsing a cron expression fails.
  *
+ * **When to use**
+ *
+ * Use to handle invalid cron expression failures returned by `parse`.
+ *
  * **Details**
  *
  * This error provides information about what went wrong during parsing,
@@ -244,6 +271,9 @@ declare const CronParseError_base: new <A extends Record<string, any> = {}>(args
  * }
  * ```
  *
+ * @see {@link parse} for the parser that returns this error in `Result.fail`
+ * @see {@link isCronParseError} for narrowing unknown values to this error type
+ *
  * @category models
  * @since 4.0.0
  */
@@ -254,7 +284,11 @@ export declare class CronParseError extends CronParseError_base<{
     readonly [CronParseErrorTypeId]: typeof CronParseErrorTypeId;
 }
 /**
- * Checks if a given value is a CronParseError instance.
+ * Checks whether a given value is a CronParseError instance.
+ *
+ * **When to use**
+ *
+ * Use to narrow an unknown failure before handling it as a cron parse error.
  *
  * **Details**
  *
@@ -277,13 +311,21 @@ export declare class CronParseError extends CronParseError_base<{
  * console.log(Cron.isCronParseError("not an error")) // false
  * ```
  *
+ * @see {@link CronParseError} for the parse error type
+ * @see {@link parse} for producing `CronParseError` values on invalid input
+ *
  * @category guards
  * @since 4.0.0
  */
 export declare const isCronParseError: (u: unknown) => u is CronParseError;
 /**
- * Parses a cron expression into a `Cron` instance, returning a `Result` instead
- * of throwing.
+ * Parses a cron expression safely into a `Cron` instance, returning a `Result`
+ * instead of throwing.
+ *
+ * **When to use**
+ *
+ * Use to parse cron expressions from configuration or user input while handling
+ * invalid input as a `Result`.
  *
  * **Details**
  *
@@ -312,6 +354,9 @@ export declare const isCronParseError: (u: unknown) => u is CronParseError;
  * )
  * ```
  *
+ * @see {@link parseUnsafe} for throwing on invalid cron expressions
+ * @see {@link make} for constructing a schedule from explicit field constraints
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -321,7 +366,7 @@ export declare const parse: (cron: string, tz?: DateTime.TimeZone | string) => R
  *
  * **When to use**
  *
- * Use this when the input is expected to be valid and you want to avoid
+ * Use when the input is expected to be valid and you want to avoid
  * handling the `Result` type.
  *
  * **Example** (Parsing cron expressions unsafely)
@@ -346,6 +391,10 @@ export declare const parseUnsafe: (cron: string, tz?: DateTime.TimeZone | string
 /**
  * Returns `true` when a date/time matches a `Cron` schedule.
  *
+ * **When to use**
+ *
+ * Use to test whether a specific date/time satisfies a cron schedule.
+ *
  * **Details**
  *
  * Seconds, minutes, hours, months, and the optional timezone are checked
@@ -371,6 +420,9 @@ export declare const parseUnsafe: (cron: string, tz?: DateTime.TimeZone | string
  * console.log(matches3) // false - wrong day
  * ```
  *
+ * @see {@link next} for finding the next matching date/time
+ * @see {@link prev} for finding the previous matching date/time
+ *
  * @category utils
  * @since 2.0.0
  */
@@ -378,6 +430,11 @@ export declare const match: (cron: Cron, date: DateTime.DateTime.Input) => boole
 /**
  * Returns the next scheduled date/time for the given Cron instance.
  *
+ * **When to use**
+ *
+ * Use to find the next occurrence of a cron schedule after a specific date/time
+ * or after the current time.
+ *
  * **Details**
  *
  * Searches for the next date and time when the cron schedule should trigger,
@@ -401,6 +458,9 @@ export declare const match: (cron: Cron, date: DateTime.DateTime.Input) => boole
  * console.log(nextFromNow) // Next occurrence from now
  * ```
  *
+ * @see {@link prev} for finding the previous scheduled occurrence
+ * @see {@link sequence} for iterating future scheduled occurrences
+ *
  * @category utils
  * @since 2.0.0
  */
@@ -408,6 +468,22 @@ export declare const next: (cron: Cron, now?: DateTime.DateTime.Input) => Date;
 /**
  * Returns the previous scheduled date/time for the given Cron instance.
  *
+ * **When to use**
+ *
+ * Use to find the most recent occurrence of a cron schedule before a specific
+ * date/time or before the current time.
+ *
+ * **Details**
+ *
+ * When no date/time is provided, the search starts from the current time.
+ *
+ * **Gotchas**
+ *
+ * The search is strict: if the supplied date/time already matches the schedule,
+ * the result is the earlier occurrence.
+ *
+ * @see {@link next} for finding the next scheduled occurrence
+ *
  * @category utils
  * @since 3.20.0
  */
@@ -415,6 +491,10 @@ export declare const prev: (cron: Cron, now?: DateTime.DateTime.Input) => Date;
 /**
  * Returns an infinite iterator that yields dates matching the Cron schedule.
  *
+ * **When to use**
+ *
+ * Use to lazily iterate future occurrences of a cron schedule.
+ *
  * **Details**
  *
  * The iterator generates an infinite sequence of dates when the cron schedule
@@ -436,14 +516,21 @@ export declare const prev: (cron: Cron, now?: DateTime.DateTime.Input) => Date;
  * // [Mon Jan 02 2023 09:00:00, Tue Jan 03 2023 09:00:00, ...]
  * ```
  *
+ * @see {@link next} for computing one next occurrence
+ *
  * @category utils
  * @since 2.0.0
  */
 export declare const sequence: (cron: Cron, now?: DateTime.DateTime.Input) => IterableIterator<Date>;
 /**
- * An `Equivalence` instance for comparing the field restrictions of two `Cron`
+ * Equivalence instance for comparing the field restrictions of two `Cron`
  * schedules.
  *
+ * **When to use**
+ *
+ * Use to compare cron schedules through APIs that accept an equivalence
+ * relation.
+ *
  * **Details**
  *
  * This comparison checks seconds, minutes, hours, days, months, and weekdays.
@@ -473,6 +560,8 @@ export declare const sequence: (cron: Cron, now?: DateTime.DateTime.Input) => It
  * console.log(Cron.Equivalence(cron1, cron2)) // true
  * ```
  *
+ * @see {@link equals} for directly comparing two `Cron` values
+ *
  * @category instances
  * @since 2.0.0
  */
@@ -480,6 +569,11 @@ export declare const Equivalence: Equ.Equivalence<Cron>;
 /**
  * Checks whether two `Cron` instances have the same field restrictions.
  *
+ * **When to use**
+ *
+ * Use to directly compare whether two cron schedules have the same field
+ * restrictions.
+ *
  * **Details**
  *
  * The comparison checks seconds, minutes, hours, days, months, and weekdays.
@@ -510,6 +604,8 @@ export declare const Equivalence: Equ.Equivalence<Cron>;
  * console.log(Cron.equals(cron1)(cron2)) // true (curried form)
  * ```
  *
+ * @see {@link Equivalence} for the reusable equivalence instance
+ *
  * @category predicates
  * @since 2.0.0
  */
@@ -517,6 +613,11 @@ export declare const equals: {
     /**
      * Checks whether two `Cron` instances have the same field restrictions.
      *
+     * **When to use**
+     *
+     * Use to directly compare whether two cron schedules have the same field
+     * restrictions.
+     *
      * **Details**
      *
      * The comparison checks seconds, minutes, hours, days, months, and weekdays.
@@ -547,6 +648,8 @@ export declare const equals: {
      * console.log(Cron.equals(cron1)(cron2)) // true (curried form)
      * ```
      *
+     * @see {@link Equivalence} for the reusable equivalence instance
+     *
      * @category predicates
      * @since 2.0.0
      */
@@ -554,6 +657,11 @@ export declare const equals: {
     /**
      * Checks whether two `Cron` instances have the same field restrictions.
      *
+     * **When to use**
+     *
+     * Use to directly compare whether two cron schedules have the same field
+     * restrictions.
+     *
      * **Details**
      *
      * The comparison checks seconds, minutes, hours, days, months, and weekdays.
@@ -584,6 +692,8 @@ export declare const equals: {
      * console.log(Cron.equals(cron1)(cron2)) // true (curried form)
      * ```
      *
+     * @see {@link Equivalence} for the reusable equivalence instance
+     *
      * @category predicates
      * @since 2.0.0
      */

package/dist/Cron.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Cron.d.ts","sourceRoot":"","sources":["../src/Cron.ts"],"names":[],"mappings":"AA+CA,OAAO,KAAK,KAAK,QAAQ,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AAIvC,OAAO,EAAE,KAAK,WAAW,EAAqB,MAAM,kBAAkB,CAAA;AAGtE,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,eAAe,CAAA;AAE5D,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAIrC,QAAA,MAAM,MAAM,sBAAsB,CAAA;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,MAAM,WAAW,IAAK,SAAQ,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,WAAW;IAC9D,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAC7C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACnC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAClC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAqCvC;AAyDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,MAAM,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,IAA8B,CAAA;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmGG;AACH,eAAO,MAAM,IAAI,GAAI,QAAQ;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAC/C,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAClC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC/B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACjC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACnC,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAA;CAC5C,KAAG,IAsDH,CAAA;AAmCD,QAAA,MAAM,oBAAoB,qCAAqC,CAAA;;;;AAE/D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,cAAe,SAAQ,oBAAmC;IACrE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CACxB,CAAC;IACA,QAAQ,CAAC,CAAC,oBAAoB,CAAC,EAAE,OAAO,oBAAoB,CAAuB;CACpF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,gBAAgB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,cAAsD,CAAA;AAEzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,KAAK,GAAI,MAAM,MAAM,EAAE,KAAK,QAAQ,CAAC,QAAQ,GAAG,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CA2BvG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,EAAE,KAAK,QAAQ,CAAC,QAAQ,GAAG,MAAM,KAAG,IAA0C,CAAA;AAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,KAAK,GAAI,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,OAkCjE,CAAA;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,IAEhE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,IAEhE,CAAA;AA4JD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,QAAQ,GAAa,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,gBAAgB,CAAC,IAAI,CAIlG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,CAO7C,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAA;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAA;CACsC,CAAA"}
+{"version":3,"file":"Cron.d.ts","sourceRoot":"","sources":["../src/Cron.ts"],"names":[],"mappings":"AA+CA,OAAO,KAAK,KAAK,QAAQ,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AAIvC,OAAO,EAAE,KAAK,WAAW,EAAqB,MAAM,kBAAkB,CAAA;AAGtE,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,eAAe,CAAA;AAE5D,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAIrC,QAAA,MAAM,MAAM,sBAAsB,CAAA;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,MAAM,WAAW,IAAK,SAAQ,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,WAAW;IAC9D,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAC7C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACnC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAClC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAqCvC;AAyDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,MAAM,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,IAA8B,CAAA;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACH,eAAO,MAAM,IAAI,GAAI,QAAQ;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAC/C,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAClC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC/B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACjC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACnC,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAA;CAC5C,KAAG,IAsDH,CAAA;AAmCD,QAAA,MAAM,oBAAoB,qCAAqC,CAAA;;;;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,cAAe,SAAQ,oBAAmC;IACrE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CACxB,CAAC;IACA,QAAQ,CAAC,CAAC,oBAAoB,CAAC,EAAE,OAAO,oBAAoB,CAAuB;CACpF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,gBAAgB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,cAAsD,CAAA;AAEzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,eAAO,MAAM,KAAK,GAAI,MAAM,MAAM,EAAE,KAAK,QAAQ,CAAC,QAAQ,GAAG,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CA2BvG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,EAAE,KAAK,QAAQ,CAAC,QAAQ,GAAG,MAAM,KAAG,IAA0C,CAAA;AAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,KAAK,GAAI,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,OAkCjE,CAAA;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,IAEhE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,IAEhE,CAAA;AA4JD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,QAAQ,GAAa,MAAM,IAAI,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,KAAG,gBAAgB,CAAC,IAAI,CAIlG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,CAO7C,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAA;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAA;CACsC,CAAA"}

package/dist/Cron.js

@@ -105,7 +105,11 @@ const CronProto = {
   }
 };
 /**
- * Checks if a given value is a Cron instance.
+ * Checks whether a given value is a Cron instance.
+ *
+ * **When to use**
+ *
+ * Use to narrow an unknown value before treating it as a `Cron` schedule.
  *
  * **Details**
  *
@@ -131,6 +135,9 @@ const CronProto = {
  * console.log(Cron.isCron("not a cron")) // false
  * ```
  *
+ * @see {@link make} for constructing a `Cron` value directly
+ * @see {@link parse} for constructing a `Cron` value from a string
+ *
  * @category guards
  * @since 2.0.0
  */
@@ -138,6 +145,10 @@ export const isCron = u => hasProperty(u, TypeId);
 /**
  * Creates a Cron instance from time constraints.
  *
+ * **When to use**
+ *
+ * Use to build a cron schedule from explicit sets of allowed time-field values.
+ *
  * **Details**
  *
  * Constructs a cron schedule by specifying which seconds, minutes, hours,
@@ -232,6 +243,8 @@ export const isCron = u => hasProperty(u, TypeId);
  * })
  * ```
  *
+ * @see {@link parse} for building a schedule from a cron expression string
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -313,6 +326,10 @@ const CronParseErrorTypeId = "~effect/time/Cron/CronParseError";
 /**
  * Represents an error that occurs when parsing a cron expression fails.
  *
+ * **When to use**
+ *
+ * Use to handle invalid cron expression failures returned by `parse`.
+ *
  * **Details**
  *
  * This error provides information about what went wrong during parsing,
@@ -331,6 +348,9 @@ const CronParseErrorTypeId = "~effect/time/Cron/CronParseError";
  * }
  * ```
  *
+ * @see {@link parse} for the parser that returns this error in `Result.fail`
+ * @see {@link isCronParseError} for narrowing unknown values to this error type
+ *
  * @category models
  * @since 4.0.0
  */
@@ -338,7 +358,11 @@ export class CronParseError extends /*#__PURE__*/Data.TaggedError("CronParseErro
   [CronParseErrorTypeId] = CronParseErrorTypeId;
 }
 /**
- * Checks if a given value is a CronParseError instance.
+ * Checks whether a given value is a CronParseError instance.
+ *
+ * **When to use**
+ *
+ * Use to narrow an unknown failure before handling it as a cron parse error.
  *
  * **Details**
  *
@@ -361,13 +385,21 @@ export class CronParseError extends /*#__PURE__*/Data.TaggedError("CronParseErro
  * console.log(Cron.isCronParseError("not an error")) // false
  * ```
  *
+ * @see {@link CronParseError} for the parse error type
+ * @see {@link parse} for producing `CronParseError` values on invalid input
+ *
  * @category guards
  * @since 4.0.0
  */
 export const isCronParseError = u => hasProperty(u, CronParseErrorTypeId);
 /**
- * Parses a cron expression into a `Cron` instance, returning a `Result` instead
- * of throwing.
+ * Parses a cron expression safely into a `Cron` instance, returning a `Result`
+ * instead of throwing.
+ *
+ * **When to use**
+ *
+ * Use to parse cron expressions from configuration or user input while handling
+ * invalid input as a `Result`.
  *
  * **Details**
  *
@@ -396,6 +428,9 @@ export const isCronParseError = u => hasProperty(u, CronParseErrorTypeId);
  * )
  * ```
  *
+ * @see {@link parseUnsafe} for throwing on invalid cron expressions
+ * @see {@link make} for constructing a schedule from explicit field constraints
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -430,7 +465,7 @@ export const parse = (cron, tz) => {
  *
  * **When to use**
  *
- * Use this when the input is expected to be valid and you want to avoid
+ * Use when the input is expected to be valid and you want to avoid
  * handling the `Result` type.
  *
  * **Example** (Parsing cron expressions unsafely)
@@ -455,6 +490,10 @@ export const parseUnsafe = (cron, tz) => Result.getOrThrow(parse(cron, tz));
 /**
  * Returns `true` when a date/time matches a `Cron` schedule.
  *
+ * **When to use**
+ *
+ * Use to test whether a specific date/time satisfies a cron schedule.
+ *
  * **Details**
  *
  * Seconds, minutes, hours, months, and the optional timezone are checked
@@ -480,6 +519,9 @@ export const parseUnsafe = (cron, tz) => Result.getOrThrow(parse(cron, tz));
  * console.log(matches3) // false - wrong day
  * ```
  *
+ * @see {@link next} for finding the next matching date/time
+ * @see {@link prev} for finding the previous matching date/time
+ *
  * @category utils
  * @since 2.0.0
  */
@@ -514,6 +556,11 @@ const daysInMonth = date => new Date(Date.UTC(date.getUTCFullYear(), date.getUTC
 /**
  * Returns the next scheduled date/time for the given Cron instance.
  *
+ * **When to use**
+ *
+ * Use to find the next occurrence of a cron schedule after a specific date/time
+ * or after the current time.
+ *
  * **Details**
  *
  * Searches for the next date and time when the cron schedule should trigger,
@@ -537,6 +584,9 @@ const daysInMonth = date => new Date(Date.UTC(date.getUTCFullYear(), date.getUTC
  * console.log(nextFromNow) // Next occurrence from now
  * ```
  *
+ * @see {@link prev} for finding the previous scheduled occurrence
+ * @see {@link sequence} for iterating future scheduled occurrences
+ *
  * @category utils
  * @since 2.0.0
  */
@@ -546,6 +596,22 @@ export const next = (cron, now) => {
 /**
  * Returns the previous scheduled date/time for the given Cron instance.
  *
+ * **When to use**
+ *
+ * Use to find the most recent occurrence of a cron schedule before a specific
+ * date/time or before the current time.
+ *
+ * **Details**
+ *
+ * When no date/time is provided, the search starts from the current time.
+ *
+ * **Gotchas**
+ *
+ * The search is strict: if the supplied date/time already matches the schedule,
+ * the result is the earlier occurrence.
+ *
+ * @see {@link next} for finding the next scheduled occurrence
+ *
  * @category utils
  * @since 3.20.0
  */
@@ -688,6 +754,10 @@ const stepCron = (cron, now, direction) => {
 /**
  * Returns an infinite iterator that yields dates matching the Cron schedule.
  *
+ * **When to use**
+ *
+ * Use to lazily iterate future occurrences of a cron schedule.
+ *
  * **Details**
  *
  * The iterator generates an infinite sequence of dates when the cron schedule
@@ -709,6 +779,8 @@ const stepCron = (cron, now, direction) => {
  * // [Mon Jan 02 2023 09:00:00, Tue Jan 03 2023 09:00:00, ...]
  * ```
  *
+ * @see {@link next} for computing one next occurrence
+ *
  * @category utils
  * @since 2.0.0
  */
@@ -718,9 +790,14 @@ export const sequence = function* (cron, now) {
   }
 };
 /**
- * An `Equivalence` instance for comparing the field restrictions of two `Cron`
+ * Equivalence instance for comparing the field restrictions of two `Cron`
  * schedules.
  *
+ * **When to use**
+ *
+ * Use to compare cron schedules through APIs that accept an equivalence
+ * relation.
+ *
  * **Details**
  *
  * This comparison checks seconds, minutes, hours, days, months, and weekdays.
@@ -750,6 +827,8 @@ export const sequence = function* (cron, now) {
  * console.log(Cron.Equivalence(cron1, cron2)) // true
  * ```
  *
+ * @see {@link equals} for directly comparing two `Cron` values
+ *
  * @category instances
  * @since 2.0.0
  */
@@ -759,6 +838,11 @@ const restrictionsEquals = (self, that) => restrictionsArrayEquals(Arr.fromItera
 /**
  * Checks whether two `Cron` instances have the same field restrictions.
  *
+ * **When to use**
+ *
+ * Use to directly compare whether two cron schedules have the same field
+ * restrictions.
+ *
  * **Details**
  *
  * The comparison checks seconds, minutes, hours, days, months, and weekdays.
@@ -789,6 +873,8 @@ const restrictionsEquals = (self, that) => restrictionsArrayEquals(Arr.fromItera
  * console.log(Cron.equals(cron1)(cron2)) // true (curried form)
  * ```
  *
+ * @see {@link Equivalence} for the reusable equivalence instance
+ *
  * @category predicates
  * @since 2.0.0
  */