aboutsummaryrefslogtreecommitdiff
path: root/src/modules/database
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2022-09-08 23:40:52 +0700
committerGitHub <[email protected]>2022-09-08 16:40:52 +0000
commit1fe2877d0c6b237b3d1a5b6b29c4749578a8f9a4 (patch)
tree85cc657b23f9209dcba347823f0e47ac70b7d8a6 /src/modules/database
parent508082cbde088d2834b324c15dd75f326cb896c7 (diff)
downloadfaker-1fe2877d0c6b237b3d1a5b6b29c4749578a8f9a4.tar.xz
faker-1fe2877d0c6b237b3d1a5b6b29c4749578a8f9a4.zip
docs: add `@since` tags to all methods (#1337)
Diffstat (limited to 'src/modules/database')
-rw-r--r--src/modules/database/index.ts10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/modules/database/index.ts b/src/modules/database/index.ts
index 69e07315..87494315 100644
--- a/src/modules/database/index.ts
+++ b/src/modules/database/index.ts
@@ -19,6 +19,8 @@ export class Database {
*
* @example
* faker.database.column() // 'createdAt'
+ *
+ * @since 4.0.0
*/
column(): string {
return this.faker.helpers.arrayElement(
@@ -31,6 +33,8 @@ export class Database {
*
* @example
* faker.database.type() // 'timestamp'
+ *
+ * @since 4.0.0
*/
type(): string {
return this.faker.helpers.arrayElement(
@@ -43,6 +47,8 @@ export class Database {
*
* @example
* faker.database.collation() // 'utf8_unicode_ci'
+ *
+ * @since 4.0.0
*/
collation(): string {
return this.faker.helpers.arrayElement(
@@ -55,6 +61,8 @@ export class Database {
*
* @example
* faker.database.engine() // 'ARCHIVE'
+ *
+ * @since 4.0.0
*/
engine(): string {
return this.faker.helpers.arrayElement(
@@ -67,6 +75,8 @@ export class Database {
*
* @example
* faker.database.mongodbObjectId() // 'e175cac316a79afdd0ad3afb'
+ *
+ * @since 6.2.0
*/
mongodbObjectId(): string {
return this.faker.datatype.hexadecimal({