aboutsummaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2024-02-06 15:12:17 +0700
committerGitHub <[email protected]>2024-02-06 09:12:17 +0100
commitbaa21f8e09a1736a1a668221b0e1ff083655ebb3 (patch)
tree7ed5fdd24ebddf63600cde0f57d08710ad73221e /src/modules
parent45b012e5a7884411211d1584b3027731eaae344f (diff)
downloadfaker-baa21f8e09a1736a1a668221b0e1ff083655ebb3.tar.xz
faker-baa21f8e09a1736a1a668221b0e1ff083655ebb3.zip
docs: clarify that the result of faker.date.betweens() is sorted (#2635)
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/date/index.ts2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/modules/date/index.ts b/src/modules/date/index.ts
index 9b96e704..9e8002d2 100644
--- 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.