docs: clarify that the result of faker.date.betweens() is sorted (#2635)

matthewmayer · web-flow · commit baa21f8e09a1 · 2024-02-06T09:12:17.000+01:00
diff --git a/src/modules/date/index.ts b/src/modules/date/index.ts
@@ -409,7 +409,7 @@ export class SimpleDateModule extends SimpleModuleBase {
   }
 
   /**
-   * Generates random dates between the given boundaries.
+   * Generates random dates between the given boundaries. The dates will be returned in an array sorted in chronological order.
    *
    * @param options The optional options object.
    * @param options.from The early date boundary.

Original file line number	Diff line number	Diff line change
`@@ -409,7 +409,7 @@ export class SimpleDateModule extends SimpleModuleBase {`
`409`	`409`	`}`
`410`	`410`
`411`	`411`	`/**`
`412`		`- * Generates random dates between the given boundaries.`
	`412`	`+ * Generates random dates between the given boundaries. The dates will be returned in an array sorted in chronological order.`
`413`	`413`	`*`
`414`	`414`	`* @param options The optional options object.`
`415`	`415`	`* @param options.from The early date boundary.`