From 80ffac67a087d4b444411cb317df3f06cb873a75 Mon Sep 17 00:00:00 2001 From: "lukasz.klejszta" Date: Tue, 19 Jul 2022 12:23:55 +0200 Subject: [PATCH] feat: add rest of examples --- packages/falso/src/lib/abbreviation.ts | 1 + packages/falso/src/lib/accessory.ts | 3 +++ packages/falso/src/lib/address.ts | 3 +++ packages/falso/src/lib/airline.ts | 3 +++ packages/falso/src/lib/airport-code.ts | 3 +++ packages/falso/src/lib/airport-name.ts | 3 +++ packages/falso/src/lib/airport.ts | 3 +++ packages/falso/src/lib/alpha-numeric.ts | 3 +++ packages/falso/src/lib/alpha.ts | 3 +++ packages/falso/src/lib/american-football-team.ts | 3 +++ packages/falso/src/lib/amount.ts | 3 +++ packages/falso/src/lib/animal-type.ts | 3 +++ packages/falso/src/lib/arn.ts | 3 +++ packages/falso/src/lib/avatar.ts | 3 +++ packages/falso/src/lib/aws-region.ts | 3 +++ packages/falso/src/lib/aws-request-id.ts | 3 +++ packages/falso/src/lib/aws-service.ts | 3 +++ packages/falso/src/lib/baseball-team.ts | 3 +++ packages/falso/src/lib/basketball-team.ts | 3 +++ packages/falso/src/lib/bear.ts | 3 +++ packages/falso/src/lib/between-date.ts | 3 +++ packages/falso/src/lib/bic.ts | 3 +++ packages/falso/src/lib/binary.ts | 3 +++ packages/falso/src/lib/bird.ts | 3 +++ packages/falso/src/lib/bitcoin-address.ts | 3 +++ packages/falso/src/lib/book.ts | 3 +++ packages/falso/src/lib/boolean.ts | 3 +++ packages/falso/src/lib/brand.ts | 3 +++ packages/falso/src/lib/browser.ts | 3 +++ packages/falso/src/lib/cardinal-direction.ts | 3 +++ packages/falso/src/lib/cat.ts | 3 +++ packages/falso/src/lib/catch-phrase.ts | 3 +++ packages/falso/src/lib/cetacean.ts | 3 +++ packages/falso/src/lib/city.ts | 3 +++ packages/falso/src/lib/clothing-size.ts | 3 +++ packages/falso/src/lib/code-snippet.ts | 3 +++ packages/falso/src/lib/color.ts | 3 +++ packages/falso/src/lib/company-name.ts | 3 +++ packages/falso/src/lib/country-code.ts | 3 +++ packages/falso/src/lib/country.ts | 3 +++ packages/falso/src/lib/county.ts | 3 +++ packages/falso/src/lib/cow.ts | 3 +++ packages/falso/src/lib/credit-card-brand.ts | 3 +++ packages/falso/src/lib/credit-card-cvv.ts | 3 +++ packages/falso/src/lib/credit-card-number.ts | 3 +++ packages/falso/src/lib/credit-card.ts | 3 +++ packages/falso/src/lib/crocodilia.ts | 3 +++ packages/falso/src/lib/currency-code.ts | 3 +++ packages/falso/src/lib/currency-name.ts | 3 +++ packages/falso/src/lib/currency-symbol.ts | 3 +++ packages/falso/src/lib/database-collation.ts | 3 +++ packages/falso/src/lib/database-column.ts | 3 +++ packages/falso/src/lib/database-engine.ts | 3 +++ packages/falso/src/lib/database-type.ts | 3 +++ packages/falso/src/lib/department.ts | 3 +++ packages/falso/src/lib/direction.ts | 3 +++ packages/falso/src/lib/directory-path.ts | 3 +++ packages/falso/src/lib/dog.ts | 3 +++ packages/falso/src/lib/domain-name.ts | 3 +++ packages/falso/src/lib/domain-suffix.ts | 3 +++ packages/falso/src/lib/drinks.ts | 3 +++ packages/falso/src/lib/email-provider.ts | 3 +++ packages/falso/src/lib/email.ts | 3 +++ packages/falso/src/lib/emoji.ts | 3 +++ packages/falso/src/lib/ethereum-address.ts | 3 +++ packages/falso/src/lib/file-ext.ts | 3 +++ packages/falso/src/lib/file-name.ts | 3 +++ packages/falso/src/lib/file-path.ts | 3 +++ packages/falso/src/lib/file-type.ts | 3 +++ packages/falso/src/lib/first-name.ts | 3 +++ packages/falso/src/lib/fish.ts | 3 +++ packages/falso/src/lib/flight-details.ts | 3 +++ packages/falso/src/lib/flight-number.ts | 3 +++ packages/falso/src/lib/float.ts | 3 +++ packages/falso/src/lib/font-family.ts | 3 +++ packages/falso/src/lib/font-size.ts | 3 +++ packages/falso/src/lib/food.ts | 3 +++ packages/falso/src/lib/football-team.ts | 3 +++ packages/falso/src/lib/frequency.ts | 3 +++ packages/falso/src/lib/full-address.ts | 3 +++ packages/falso/src/lib/full-name.ts | 3 +++ packages/falso/src/lib/future-date.ts | 3 +++ packages/falso/src/lib/gender.ts | 3 +++ packages/falso/src/lib/git-branch.ts | 3 +++ packages/falso/src/lib/git-commit-entry.ts | 3 +++ packages/falso/src/lib/git-commit-message.ts | 3 +++ packages/falso/src/lib/git-commit-sha.ts | 3 +++ packages/falso/src/lib/git-short-sha.ts | 3 +++ packages/falso/src/lib/hex.ts | 3 +++ packages/falso/src/lib/hexa-decimal.ts | 5 ++++- packages/falso/src/lib/horse.ts | 3 +++ packages/falso/src/lib/hsl.ts | 3 +++ packages/falso/src/lib/http-method.ts | 3 +++ packages/falso/src/lib/i18n/ar/bird.ts | 3 +++ packages/falso/src/lib/i18n/es/bird.ts | 3 +++ packages/falso/src/lib/i18n/fr/bird.ts | 3 +++ packages/falso/src/lib/i18n/hi/bird.ts | 3 +++ packages/falso/src/lib/i18n/ru/bird.ts | 3 +++ packages/falso/src/lib/i18n/se/bird.ts | 3 +++ packages/falso/src/lib/i18n/zh/bird.ts | 3 +++ packages/falso/src/lib/iban.ts | 3 +++ packages/falso/src/lib/ice-hockey-team.ts | 3 +++ packages/falso/src/lib/img.ts | 3 +++ packages/falso/src/lib/integration.ts | 3 +++ packages/falso/src/lib/ip.ts | 3 +++ packages/falso/src/lib/ipv6.ts | 3 +++ packages/falso/src/lib/job-area.ts | 3 +++ packages/falso/src/lib/job-descriptor.ts | 3 +++ packages/falso/src/lib/job-title.ts | 3 +++ packages/falso/src/lib/job-type.ts | 3 +++ packages/falso/src/lib/json.ts | 3 +++ packages/falso/src/lib/language.ts | 3 +++ packages/falso/src/lib/last-name.ts | 3 +++ packages/falso/src/lib/latitude.ts | 3 +++ packages/falso/src/lib/line.ts | 3 +++ packages/falso/src/lib/lines.ts | 3 +++ packages/falso/src/lib/lion.ts | 3 +++ packages/falso/src/lib/locale.ts | 3 +++ packages/falso/src/lib/longitude.ts | 3 +++ packages/falso/src/lib/mac.ts | 3 +++ packages/falso/src/lib/mask.ts | 3 +++ packages/falso/src/lib/mime-type.ts | 3 +++ packages/falso/src/lib/month.ts | 3 +++ packages/falso/src/lib/movie-character.ts | 3 +++ packages/falso/src/lib/movie.ts | 3 +++ packages/falso/src/lib/music-genre.ts | 3 +++ packages/falso/src/lib/nearby-gpscoordinate.ts | 3 +++ packages/falso/src/lib/number.ts | 3 +++ packages/falso/src/lib/oauth-provider.ts | 3 +++ packages/falso/src/lib/octal.ts | 3 +++ packages/falso/src/lib/ordinal-direction.ts | 3 +++ packages/falso/src/lib/paragraph.ts | 3 +++ packages/falso/src/lib/password.ts | 3 +++ packages/falso/src/lib/past-date.ts | 3 +++ packages/falso/src/lib/permission.ts | 3 +++ packages/falso/src/lib/person-title.ts | 3 +++ packages/falso/src/lib/phone-number.ts | 3 +++ packages/falso/src/lib/phrase.ts | 3 +++ packages/falso/src/lib/port.ts | 3 +++ packages/falso/src/lib/post.ts | 3 +++ packages/falso/src/lib/priority.ts | 3 +++ packages/falso/src/lib/product-adjective.ts | 3 +++ packages/falso/src/lib/product-category.ts | 3 +++ packages/falso/src/lib/product-description.ts | 3 +++ packages/falso/src/lib/product-material.ts | 3 +++ packages/falso/src/lib/product-name.ts | 3 +++ packages/falso/src/lib/product.ts | 3 +++ packages/falso/src/lib/programming-language.ts | 3 +++ packages/falso/src/lib/pronoun.ts | 3 +++ packages/falso/src/lib/protocol.ts | 3 +++ packages/falso/src/lib/quote.ts | 3 +++ packages/falso/src/lib/rabbit.ts | 3 +++ packages/falso/src/lib/rand.ts | 3 +++ packages/falso/src/lib/random.ts | 5 +++++ packages/falso/src/lib/recent-date.ts | 3 +++ packages/falso/src/lib/rgb.ts | 3 +++ packages/falso/src/lib/role.ts | 3 +++ packages/falso/src/lib/routing-number.ts | 3 +++ packages/falso/src/lib/seat-number.ts | 3 +++ packages/falso/src/lib/semver.ts | 3 +++ packages/falso/src/lib/sentence.ts | 3 +++ packages/falso/src/lib/sequence.ts | 3 +++ packages/falso/src/lib/shape.ts | 3 +++ packages/falso/src/lib/singer.ts | 3 +++ packages/falso/src/lib/skill.ts | 3 +++ packages/falso/src/lib/slug.ts | 3 +++ packages/falso/src/lib/snake.ts | 3 +++ packages/falso/src/lib/song.ts | 3 +++ packages/falso/src/lib/soon-date.ts | 3 +++ packages/falso/src/lib/sports-team.ts | 3 +++ packages/falso/src/lib/sports.ts | 3 +++ packages/falso/src/lib/state-abbr.ts | 3 +++ packages/falso/src/lib/state.ts | 3 +++ packages/falso/src/lib/street-address.ts | 3 +++ packages/falso/src/lib/street-name.ts | 3 +++ packages/falso/src/lib/subscription-plan.ts | 3 +++ packages/falso/src/lib/superhero-name.ts | 3 +++ packages/falso/src/lib/superhero.ts | 3 +++ packages/falso/src/lib/svg.ts | 3 +++ packages/falso/src/lib/swift.ts | 3 +++ packages/falso/src/lib/text-range.ts | 3 +++ packages/falso/src/lib/text.ts | 3 +++ packages/falso/src/lib/time-zone.ts | 3 +++ packages/falso/src/lib/todo.ts | 3 +++ packages/falso/src/lib/transaction-type.ts | 3 +++ packages/falso/src/lib/url.ts | 3 +++ packages/falso/src/lib/user-agent.ts | 3 +++ packages/falso/src/lib/user-name.ts | 3 +++ packages/falso/src/lib/user.ts | 3 +++ packages/falso/src/lib/uuid.ts | 3 +++ packages/falso/src/lib/vehicle-fuel.ts | 3 +++ packages/falso/src/lib/vehicle-manufacturer.ts | 3 +++ packages/falso/src/lib/vehicle-model.ts | 3 +++ packages/falso/src/lib/vehicle-type.ts | 3 +++ packages/falso/src/lib/vehicle.ts | 3 +++ packages/falso/src/lib/verb.ts | 3 +++ packages/falso/src/lib/weekday.ts | 3 +++ packages/falso/src/lib/word.ts | 3 +++ packages/falso/src/lib/zip-code.ts | 3 +++ 199 files changed, 598 insertions(+), 1 deletion(-) diff --git a/packages/falso/src/lib/abbreviation.ts b/packages/falso/src/lib/abbreviation.ts index 030b5aa7d..11b844493 100644 --- a/packages/falso/src/lib/abbreviation.ts +++ b/packages/falso/src/lib/abbreviation.ts @@ -20,6 +20,7 @@ import { data } from './abbreviation.json'; * SMTP * ADP */ + export function randAbbreviation(options?: O) { return fake(data, options); } diff --git a/packages/falso/src/lib/accessory.ts b/packages/falso/src/lib/accessory.ts index fb9eae78d..646e2f09b 100644 --- a/packages/falso/src/lib/accessory.ts +++ b/packages/falso/src/lib/accessory.ts @@ -14,7 +14,10 @@ import { data } from './accessory.json'; * * randAccessory({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAccessory( options?: Options ) { diff --git a/packages/falso/src/lib/address.ts b/packages/falso/src/lib/address.ts index cbafe0631..56d6c33de 100644 --- a/packages/falso/src/lib/address.ts +++ b/packages/falso/src/lib/address.ts @@ -39,7 +39,10 @@ export interface Address { * * randAddress({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAddress( options?: Options ) { diff --git a/packages/falso/src/lib/airline.ts b/packages/falso/src/lib/airline.ts index 9b37efdb8..8136c5f60 100644 --- a/packages/falso/src/lib/airline.ts +++ b/packages/falso/src/lib/airline.ts @@ -14,7 +14,10 @@ import { data } from './airline.json'; * * randAirline({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAirline( options?: Options ) { diff --git a/packages/falso/src/lib/airport-code.ts b/packages/falso/src/lib/airport-code.ts index c3aa0854c..06fc47ec6 100644 --- a/packages/falso/src/lib/airport-code.ts +++ b/packages/falso/src/lib/airport-code.ts @@ -15,7 +15,10 @@ import { rand } from './rand'; * * randAirportCode({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAirportCode( options?: Options ) { diff --git a/packages/falso/src/lib/airport-name.ts b/packages/falso/src/lib/airport-name.ts index c81461b5c..1b1a073cd 100644 --- a/packages/falso/src/lib/airport-name.ts +++ b/packages/falso/src/lib/airport-name.ts @@ -15,7 +15,10 @@ import { rand } from './rand'; * * randAirportName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAirportName( options?: Options ) { diff --git a/packages/falso/src/lib/airport.ts b/packages/falso/src/lib/airport.ts index fac0e177f..422037be3 100644 --- a/packages/falso/src/lib/airport.ts +++ b/packages/falso/src/lib/airport.ts @@ -21,7 +21,10 @@ export interface Airport { * * randAirport({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAirport( options?: Options ) { diff --git a/packages/falso/src/lib/alpha-numeric.ts b/packages/falso/src/lib/alpha-numeric.ts index c47465624..a72900551 100644 --- a/packages/falso/src/lib/alpha-numeric.ts +++ b/packages/falso/src/lib/alpha-numeric.ts @@ -16,7 +16,10 @@ import { randNumber } from './number'; * * randAlphaNumeric({ length: 3 }) * + * + * @automaticallyGeneratedExamples */ + export function randAlphaNumeric( options?: Options ) { diff --git a/packages/falso/src/lib/alpha.ts b/packages/falso/src/lib/alpha.ts index 30125cca0..e88f6f09c 100644 --- a/packages/falso/src/lib/alpha.ts +++ b/packages/falso/src/lib/alpha.ts @@ -14,7 +14,10 @@ import { alphaChars } from './sequence'; * * randAlpha({ length: 3 }) * + * + * @automaticallyGeneratedExamples */ + export function randAlpha( options?: Options ) { diff --git a/packages/falso/src/lib/american-football-team.ts b/packages/falso/src/lib/american-football-team.ts index d3aec877f..41c5bee26 100644 --- a/packages/falso/src/lib/american-football-team.ts +++ b/packages/falso/src/lib/american-football-team.ts @@ -14,7 +14,10 @@ import { data } from './american-football-team.json'; * * randAmericanFootballTeam({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAmericanFootballTeam( options?: Options ) { diff --git a/packages/falso/src/lib/amount.ts b/packages/falso/src/lib/amount.ts index bd691472a..68681d031 100644 --- a/packages/falso/src/lib/amount.ts +++ b/packages/falso/src/lib/amount.ts @@ -35,7 +35,10 @@ export interface RandomAmountOptions extends RandomInRangeOptions, FakeOptions { * @example * * randAmount({ length: 10 }) + * + * @automaticallyGeneratedExamples */ + export function randAmount< Options extends markRequired >(options: Options): Return; diff --git a/packages/falso/src/lib/animal-type.ts b/packages/falso/src/lib/animal-type.ts index b08f3ddaf..fb3698e7c 100644 --- a/packages/falso/src/lib/animal-type.ts +++ b/packages/falso/src/lib/animal-type.ts @@ -14,7 +14,10 @@ import { data } from './animal-type.json'; * * randAnimalType({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAnimalType( options?: Options ) { diff --git a/packages/falso/src/lib/arn.ts b/packages/falso/src/lib/arn.ts index 723d4fbb0..91abce827 100644 --- a/packages/falso/src/lib/arn.ts +++ b/packages/falso/src/lib/arn.ts @@ -35,7 +35,10 @@ const serviceArn: Record string> = { * * randArn({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randArn( options?: Options ) { diff --git a/packages/falso/src/lib/avatar.ts b/packages/falso/src/lib/avatar.ts index 04dda6dfd..ae08b8f0f 100644 --- a/packages/falso/src/lib/avatar.ts +++ b/packages/falso/src/lib/avatar.ts @@ -21,7 +21,10 @@ interface AvatarOptions extends FakeOptions { * * randAvatar({ size: 200 }) // default is 100 * + * + * @automaticallyGeneratedExamples */ + export function randAvatar( options?: Options ) { diff --git a/packages/falso/src/lib/aws-region.ts b/packages/falso/src/lib/aws-region.ts index 9998257ad..f9fd5e4f2 100644 --- a/packages/falso/src/lib/aws-region.ts +++ b/packages/falso/src/lib/aws-region.ts @@ -14,7 +14,10 @@ import { data } from './aws-region.json'; * * randAwsRegion({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAwsRegion( options?: Options ) { diff --git a/packages/falso/src/lib/aws-request-id.ts b/packages/falso/src/lib/aws-request-id.ts index 3b63608b5..997971f0f 100644 --- a/packages/falso/src/lib/aws-request-id.ts +++ b/packages/falso/src/lib/aws-request-id.ts @@ -14,7 +14,10 @@ import { fake, FakeOptions } from './core/core'; * * randAwsRequestId({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAwsRequestId( options?: Options ) { diff --git a/packages/falso/src/lib/aws-service.ts b/packages/falso/src/lib/aws-service.ts index c3a8f46bc..dafac553c 100644 --- a/packages/falso/src/lib/aws-service.ts +++ b/packages/falso/src/lib/aws-service.ts @@ -14,7 +14,10 @@ import { data } from './aws-service.json'; * * randAwsService({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randAwsService( options?: Options ) { diff --git a/packages/falso/src/lib/baseball-team.ts b/packages/falso/src/lib/baseball-team.ts index 2ab088916..385048a21 100644 --- a/packages/falso/src/lib/baseball-team.ts +++ b/packages/falso/src/lib/baseball-team.ts @@ -14,7 +14,10 @@ import { data } from './baseball-team.json'; * * randBaseballTeam({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBaseballTeam( options?: Options ) { diff --git a/packages/falso/src/lib/basketball-team.ts b/packages/falso/src/lib/basketball-team.ts index afcec1f29..621ae663f 100644 --- a/packages/falso/src/lib/basketball-team.ts +++ b/packages/falso/src/lib/basketball-team.ts @@ -14,7 +14,10 @@ import { data } from './basketball-team.json'; * * randBasketballTeam({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBasketballTeam( options?: Options ) { diff --git a/packages/falso/src/lib/bear.ts b/packages/falso/src/lib/bear.ts index af00eff74..e89113c57 100644 --- a/packages/falso/src/lib/bear.ts +++ b/packages/falso/src/lib/bear.ts @@ -14,7 +14,10 @@ import { data } from './bear.json'; * * randBear({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBear( options?: Options ) { diff --git a/packages/falso/src/lib/between-date.ts b/packages/falso/src/lib/between-date.ts index 2b06d5c21..96631f7db 100644 --- a/packages/falso/src/lib/between-date.ts +++ b/packages/falso/src/lib/between-date.ts @@ -19,7 +19,10 @@ interface BetweenOptions extends FakeOptions { * * randBetweenDate({ from: new Date('10/07/2020'), to: new Date(), length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBetweenDate( options: Options ) { diff --git a/packages/falso/src/lib/bic.ts b/packages/falso/src/lib/bic.ts index ccd1626cd..1479303c0 100644 --- a/packages/falso/src/lib/bic.ts +++ b/packages/falso/src/lib/bic.ts @@ -34,7 +34,10 @@ import { randSwift, SwiftOptions } from './swift'; * * randBic({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBic( options?: Options ) { diff --git a/packages/falso/src/lib/binary.ts b/packages/falso/src/lib/binary.ts index cb44d5d00..171efa04f 100644 --- a/packages/falso/src/lib/binary.ts +++ b/packages/falso/src/lib/binary.ts @@ -13,7 +13,10 @@ import { FakeOptions, fake, getRandomInRange } from './core/core'; * * randBinary({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBinary( options?: Options ) { diff --git a/packages/falso/src/lib/bird.ts b/packages/falso/src/lib/bird.ts index ba7236b50..fe2d5fba6 100644 --- a/packages/falso/src/lib/bird.ts +++ b/packages/falso/src/lib/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/bitcoin-address.ts b/packages/falso/src/lib/bitcoin-address.ts index 27492d95c..04871500d 100644 --- a/packages/falso/src/lib/bitcoin-address.ts +++ b/packages/falso/src/lib/bitcoin-address.ts @@ -14,7 +14,10 @@ import { randSequence } from './sequence'; * * randBitcoinAddress({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBitcoinAddress( options?: Options ) { diff --git a/packages/falso/src/lib/book.ts b/packages/falso/src/lib/book.ts index 2cf35b499..b92da5422 100644 --- a/packages/falso/src/lib/book.ts +++ b/packages/falso/src/lib/book.ts @@ -35,7 +35,10 @@ export interface Book { * * randBook({ category: 'Comedy' }) * + * + * @automaticallyGeneratedExamples */ + export function randBook( options?: Options ) { diff --git a/packages/falso/src/lib/boolean.ts b/packages/falso/src/lib/boolean.ts index fbcaf8c64..7357d1010 100644 --- a/packages/falso/src/lib/boolean.ts +++ b/packages/falso/src/lib/boolean.ts @@ -13,7 +13,10 @@ import { fake, FakeOptions, randElement } from './core/core'; * * randBoolean({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBoolean( options?: Options ) { diff --git a/packages/falso/src/lib/brand.ts b/packages/falso/src/lib/brand.ts index a295b9c48..293e4cc89 100644 --- a/packages/falso/src/lib/brand.ts +++ b/packages/falso/src/lib/brand.ts @@ -14,7 +14,10 @@ import { data } from './brand.json'; * * randBrand({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBrand( options?: Options ) { diff --git a/packages/falso/src/lib/browser.ts b/packages/falso/src/lib/browser.ts index d9a42ad9d..bef65d343 100644 --- a/packages/falso/src/lib/browser.ts +++ b/packages/falso/src/lib/browser.ts @@ -14,7 +14,10 @@ import { data } from './browser.json'; * * randBrowser({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBrowser( options?: Options ) { diff --git a/packages/falso/src/lib/cardinal-direction.ts b/packages/falso/src/lib/cardinal-direction.ts index f83a1e2e4..eac39c08e 100644 --- a/packages/falso/src/lib/cardinal-direction.ts +++ b/packages/falso/src/lib/cardinal-direction.ts @@ -14,7 +14,10 @@ import { data } from './cardinal-direction.json'; * * randCardinalDirection({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCardinalDirection( options?: Options ) { diff --git a/packages/falso/src/lib/cat.ts b/packages/falso/src/lib/cat.ts index 5a32318d1..aa74400c7 100644 --- a/packages/falso/src/lib/cat.ts +++ b/packages/falso/src/lib/cat.ts @@ -14,7 +14,10 @@ import { data } from './cat.json'; * * randCat({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCat( options?: Options ) { diff --git a/packages/falso/src/lib/catch-phrase.ts b/packages/falso/src/lib/catch-phrase.ts index 38e7e901a..1aadf7e93 100644 --- a/packages/falso/src/lib/catch-phrase.ts +++ b/packages/falso/src/lib/catch-phrase.ts @@ -14,7 +14,10 @@ import { data } from './catch-phrase.json'; * * randCatchPhrase({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCatchPhrase( options?: Options ) { diff --git a/packages/falso/src/lib/cetacean.ts b/packages/falso/src/lib/cetacean.ts index 902a7c74a..ba77a4bd3 100644 --- a/packages/falso/src/lib/cetacean.ts +++ b/packages/falso/src/lib/cetacean.ts @@ -14,7 +14,10 @@ import { data } from './cetacean.json'; * * randCetacean({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCetacean( options?: Options ) { diff --git a/packages/falso/src/lib/city.ts b/packages/falso/src/lib/city.ts index 1f105852d..679d4ac74 100644 --- a/packages/falso/src/lib/city.ts +++ b/packages/falso/src/lib/city.ts @@ -14,7 +14,10 @@ import { data } from './city.json'; * * randCity({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCity( options?: Options ) { diff --git a/packages/falso/src/lib/clothing-size.ts b/packages/falso/src/lib/clothing-size.ts index f100045b2..afeddc6a8 100644 --- a/packages/falso/src/lib/clothing-size.ts +++ b/packages/falso/src/lib/clothing-size.ts @@ -14,7 +14,10 @@ import { data } from './clothing-size.json'; * * randClothingSize({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randClothingSize( options?: Options ) { diff --git a/packages/falso/src/lib/code-snippet.ts b/packages/falso/src/lib/code-snippet.ts index 474d67358..43b181f4a 100644 --- a/packages/falso/src/lib/code-snippet.ts +++ b/packages/falso/src/lib/code-snippet.ts @@ -40,7 +40,10 @@ interface CodeSnippetOptions extends FakeOptions { * * randCodeSnippet({ lang: 'html' }) // default is 'javascript' * + * + * @automaticallyGeneratedExamples */ + export function randCodeSnippet( options?: Options ) { diff --git a/packages/falso/src/lib/color.ts b/packages/falso/src/lib/color.ts index 2239aefeb..58e35f75e 100644 --- a/packages/falso/src/lib/color.ts +++ b/packages/falso/src/lib/color.ts @@ -14,7 +14,10 @@ import { data } from './color.json'; * * randColor({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randColor( options?: Options ) { diff --git a/packages/falso/src/lib/company-name.ts b/packages/falso/src/lib/company-name.ts index 3851917c2..9e35fd2cb 100644 --- a/packages/falso/src/lib/company-name.ts +++ b/packages/falso/src/lib/company-name.ts @@ -14,7 +14,10 @@ import { data } from './company-name.json'; * * randCompanyName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCompanyName( options?: Options ) { diff --git a/packages/falso/src/lib/country-code.ts b/packages/falso/src/lib/country-code.ts index 0fa15c097..96e034dde 100644 --- a/packages/falso/src/lib/country-code.ts +++ b/packages/falso/src/lib/country-code.ts @@ -14,7 +14,10 @@ import { data } from './country-code.json'; * * randCountryCode({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCountryCode( options?: Options ) { diff --git a/packages/falso/src/lib/country.ts b/packages/falso/src/lib/country.ts index 838e3e9f7..101a2bed4 100644 --- a/packages/falso/src/lib/country.ts +++ b/packages/falso/src/lib/country.ts @@ -14,7 +14,10 @@ import { data } from './country.json'; * * randCountry({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCountry( options?: Options ) { diff --git a/packages/falso/src/lib/county.ts b/packages/falso/src/lib/county.ts index 63b416c7c..0fb5e6d40 100644 --- a/packages/falso/src/lib/county.ts +++ b/packages/falso/src/lib/county.ts @@ -14,7 +14,10 @@ import { data } from './county.json'; * * randCounty({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCounty( options?: Options ) { diff --git a/packages/falso/src/lib/cow.ts b/packages/falso/src/lib/cow.ts index 159dc5f2b..f062917ca 100644 --- a/packages/falso/src/lib/cow.ts +++ b/packages/falso/src/lib/cow.ts @@ -14,7 +14,10 @@ import { data } from './cow.json'; * * randCow({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCow( options?: Options ) { diff --git a/packages/falso/src/lib/credit-card-brand.ts b/packages/falso/src/lib/credit-card-brand.ts index 7bbbe8a19..49747c05e 100644 --- a/packages/falso/src/lib/credit-card-brand.ts +++ b/packages/falso/src/lib/credit-card-brand.ts @@ -14,7 +14,10 @@ import { data } from './credit-card-brand.json'; * * randCreditCardBrand({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCreditCardBrand( options?: Options ) { diff --git a/packages/falso/src/lib/credit-card-cvv.ts b/packages/falso/src/lib/credit-card-cvv.ts index bc002ac72..a98c5f4d6 100644 --- a/packages/falso/src/lib/credit-card-cvv.ts +++ b/packages/falso/src/lib/credit-card-cvv.ts @@ -13,7 +13,10 @@ import { fake, FakeOptions, getRandomInRange } from './core/core'; * * randCreditCardCVV({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCreditCardCVV( options?: Options ) { diff --git a/packages/falso/src/lib/credit-card-number.ts b/packages/falso/src/lib/credit-card-number.ts index 8cf4475ff..07fd16293 100644 --- a/packages/falso/src/lib/credit-card-number.ts +++ b/packages/falso/src/lib/credit-card-number.ts @@ -37,7 +37,10 @@ export type Brand = * * randCreditCardNumber({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCreditCardNumber< Options extends CreditCardNumberOptions = never >(options?: Options) { diff --git a/packages/falso/src/lib/credit-card.ts b/packages/falso/src/lib/credit-card.ts index 6a538c962..1716f8f2a 100644 --- a/packages/falso/src/lib/credit-card.ts +++ b/packages/falso/src/lib/credit-card.ts @@ -46,7 +46,10 @@ export interface CreditCard { * * randCreditCard({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCreditCard( options?: Options ) { diff --git a/packages/falso/src/lib/crocodilia.ts b/packages/falso/src/lib/crocodilia.ts index 7e7c9835c..f6da9caeb 100644 --- a/packages/falso/src/lib/crocodilia.ts +++ b/packages/falso/src/lib/crocodilia.ts @@ -14,7 +14,10 @@ import { data } from './crocodilia.json'; * * randCrocodilia({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCrocodilia( options?: Options ) { diff --git a/packages/falso/src/lib/currency-code.ts b/packages/falso/src/lib/currency-code.ts index 68b91f82e..be5393de2 100644 --- a/packages/falso/src/lib/currency-code.ts +++ b/packages/falso/src/lib/currency-code.ts @@ -14,7 +14,10 @@ import { data } from './currency-code.json'; * * randCurrencyCode({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCurrencyCode( options?: Options ) { diff --git a/packages/falso/src/lib/currency-name.ts b/packages/falso/src/lib/currency-name.ts index b432c9832..7892e879f 100644 --- a/packages/falso/src/lib/currency-name.ts +++ b/packages/falso/src/lib/currency-name.ts @@ -14,7 +14,10 @@ import { data } from './currency-name.json'; * * randCurrencyName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCurrencyName( options?: Options ) { diff --git a/packages/falso/src/lib/currency-symbol.ts b/packages/falso/src/lib/currency-symbol.ts index 57d291789..fa2be334e 100644 --- a/packages/falso/src/lib/currency-symbol.ts +++ b/packages/falso/src/lib/currency-symbol.ts @@ -14,7 +14,10 @@ import { data } from './currency-symbol.json'; * * randCurrencySymbol({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randCurrencySymbol( options?: Options ) { diff --git a/packages/falso/src/lib/database-collation.ts b/packages/falso/src/lib/database-collation.ts index d081f50cd..646f87c39 100644 --- a/packages/falso/src/lib/database-collation.ts +++ b/packages/falso/src/lib/database-collation.ts @@ -14,7 +14,10 @@ import { data } from './database-collation.json'; * * randDatabaseCollation({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDatabaseCollation( options?: Options ) { diff --git a/packages/falso/src/lib/database-column.ts b/packages/falso/src/lib/database-column.ts index 36ff6c706..780e10bd6 100644 --- a/packages/falso/src/lib/database-column.ts +++ b/packages/falso/src/lib/database-column.ts @@ -14,7 +14,10 @@ import { data } from './database-column.json'; * * randDatabaseColumn({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDatabaseColumn( options?: Options ) { diff --git a/packages/falso/src/lib/database-engine.ts b/packages/falso/src/lib/database-engine.ts index 9d36dfd6d..9023995e1 100644 --- a/packages/falso/src/lib/database-engine.ts +++ b/packages/falso/src/lib/database-engine.ts @@ -14,7 +14,10 @@ import { data } from './database-engine.json'; * * randDatabaseEngine({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDatabaseEngine( options?: Options ) { diff --git a/packages/falso/src/lib/database-type.ts b/packages/falso/src/lib/database-type.ts index ca85e1e36..9efc24ae9 100644 --- a/packages/falso/src/lib/database-type.ts +++ b/packages/falso/src/lib/database-type.ts @@ -14,7 +14,10 @@ import { data } from './database-type.json'; * * randDatabaseType({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDatabaseType( options?: Options ) { diff --git a/packages/falso/src/lib/department.ts b/packages/falso/src/lib/department.ts index 2ea8f12bc..719136368 100644 --- a/packages/falso/src/lib/department.ts +++ b/packages/falso/src/lib/department.ts @@ -14,7 +14,10 @@ import { data } from './department.json'; * * randDepartment({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDepartment( options?: Options ) { diff --git a/packages/falso/src/lib/direction.ts b/packages/falso/src/lib/direction.ts index c28c5cbe4..caefb27ca 100644 --- a/packages/falso/src/lib/direction.ts +++ b/packages/falso/src/lib/direction.ts @@ -14,7 +14,10 @@ import { data } from './direction.json'; * * randDirection({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDirection( options?: Options ) { diff --git a/packages/falso/src/lib/directory-path.ts b/packages/falso/src/lib/directory-path.ts index be4f9bf0b..53ac02309 100644 --- a/packages/falso/src/lib/directory-path.ts +++ b/packages/falso/src/lib/directory-path.ts @@ -14,7 +14,10 @@ import { data } from './directory-path.json'; * * randDirectoryPath({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDirectoryPath( options?: Options ) { diff --git a/packages/falso/src/lib/dog.ts b/packages/falso/src/lib/dog.ts index c05c9314a..2c7a4e001 100644 --- a/packages/falso/src/lib/dog.ts +++ b/packages/falso/src/lib/dog.ts @@ -14,7 +14,10 @@ import { data } from './dog.json'; * * randDog({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDog( options?: Options ) { diff --git a/packages/falso/src/lib/domain-name.ts b/packages/falso/src/lib/domain-name.ts index 675804e97..d76dd0567 100644 --- a/packages/falso/src/lib/domain-name.ts +++ b/packages/falso/src/lib/domain-name.ts @@ -15,7 +15,10 @@ import { randWord } from './word'; * * randDomainName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDomainName( options?: Options ) { diff --git a/packages/falso/src/lib/domain-suffix.ts b/packages/falso/src/lib/domain-suffix.ts index 06efa2467..a770e343c 100644 --- a/packages/falso/src/lib/domain-suffix.ts +++ b/packages/falso/src/lib/domain-suffix.ts @@ -14,7 +14,10 @@ import { data } from './domain-suffix.json'; * * randDomainSuffix({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDomainSuffix( options?: Options ) { diff --git a/packages/falso/src/lib/drinks.ts b/packages/falso/src/lib/drinks.ts index f60c59fa0..7aa631a4a 100644 --- a/packages/falso/src/lib/drinks.ts +++ b/packages/falso/src/lib/drinks.ts @@ -14,7 +14,10 @@ import { data } from './drinks.json'; * * randDrinks({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randDrinks( options?: Options ) { diff --git a/packages/falso/src/lib/email-provider.ts b/packages/falso/src/lib/email-provider.ts index 42bdb1f93..78a0d54a6 100644 --- a/packages/falso/src/lib/email-provider.ts +++ b/packages/falso/src/lib/email-provider.ts @@ -14,7 +14,10 @@ import { data } from './email-provider.json'; * * randEmailProvider({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randEmailProvider( options?: Options ) { diff --git a/packages/falso/src/lib/email.ts b/packages/falso/src/lib/email.ts index 6ade3cedf..e89ba44ab 100644 --- a/packages/falso/src/lib/email.ts +++ b/packages/falso/src/lib/email.ts @@ -72,7 +72,10 @@ function randFormattedName( * randEmail({ suffix: 'com' }) * * + * + * @automaticallyGeneratedExamples */ + export function randEmail( options?: Options ) { diff --git a/packages/falso/src/lib/emoji.ts b/packages/falso/src/lib/emoji.ts index 37b82d8ef..696d09314 100644 --- a/packages/falso/src/lib/emoji.ts +++ b/packages/falso/src/lib/emoji.ts @@ -14,7 +14,10 @@ import { data } from './emoji.json'; * * randEmoji({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randEmoji( options?: Options ) { diff --git a/packages/falso/src/lib/ethereum-address.ts b/packages/falso/src/lib/ethereum-address.ts index 71a4132b0..06487238a 100644 --- a/packages/falso/src/lib/ethereum-address.ts +++ b/packages/falso/src/lib/ethereum-address.ts @@ -14,7 +14,10 @@ import { data } from './ethereum-address.json'; * * randEthereumAddress({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randEthereumAddress( options?: Options ) { diff --git a/packages/falso/src/lib/file-ext.ts b/packages/falso/src/lib/file-ext.ts index a973d8143..e35f6a8b4 100644 --- a/packages/falso/src/lib/file-ext.ts +++ b/packages/falso/src/lib/file-ext.ts @@ -14,7 +14,10 @@ import { data } from './file-ext.json'; * * randFileExt({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFileExt( options?: Options ) { diff --git a/packages/falso/src/lib/file-name.ts b/packages/falso/src/lib/file-name.ts index d14b87234..b9a22d237 100644 --- a/packages/falso/src/lib/file-name.ts +++ b/packages/falso/src/lib/file-name.ts @@ -14,7 +14,10 @@ import { data } from './file-name.json'; * * randFileName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFileName< Options extends FakeOptions & { extension?: string } = never >(options?: Options) { diff --git a/packages/falso/src/lib/file-path.ts b/packages/falso/src/lib/file-path.ts index 703111b91..194a46d8c 100644 --- a/packages/falso/src/lib/file-path.ts +++ b/packages/falso/src/lib/file-path.ts @@ -14,7 +14,10 @@ import { data } from './file-path.json'; * * randFilePath({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFilePath( options?: Options ) { diff --git a/packages/falso/src/lib/file-type.ts b/packages/falso/src/lib/file-type.ts index 414ca4d9e..ac479190c 100644 --- a/packages/falso/src/lib/file-type.ts +++ b/packages/falso/src/lib/file-type.ts @@ -14,7 +14,10 @@ import { data } from './file-type.json'; * * randFileType({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFileType( options?: Options ) { diff --git a/packages/falso/src/lib/first-name.ts b/packages/falso/src/lib/first-name.ts index 970916127..caade6716 100644 --- a/packages/falso/src/lib/first-name.ts +++ b/packages/falso/src/lib/first-name.ts @@ -24,7 +24,10 @@ import { rand } from './rand'; * * randFirstName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFirstName( options?: Options ) { diff --git a/packages/falso/src/lib/fish.ts b/packages/falso/src/lib/fish.ts index f7a2e4f51..5e91b0e3c 100644 --- a/packages/falso/src/lib/fish.ts +++ b/packages/falso/src/lib/fish.ts @@ -14,7 +14,10 @@ import { data } from './fish.json'; * * randFish({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFish( options?: Options ) { diff --git a/packages/falso/src/lib/flight-details.ts b/packages/falso/src/lib/flight-details.ts index cb43e378d..68059d7b4 100644 --- a/packages/falso/src/lib/flight-details.ts +++ b/packages/falso/src/lib/flight-details.ts @@ -49,7 +49,10 @@ function generateFlightLength(): number { * * randFlightDetails({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFlightDetails( options?: Options ) { diff --git a/packages/falso/src/lib/flight-number.ts b/packages/falso/src/lib/flight-number.ts index ec3b43ac1..aef6cc40b 100644 --- a/packages/falso/src/lib/flight-number.ts +++ b/packages/falso/src/lib/flight-number.ts @@ -74,7 +74,10 @@ function generateStandardFlightNumber({ * * randFlightNumber({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFlightNumber( options?: Options ) { diff --git a/packages/falso/src/lib/float.ts b/packages/falso/src/lib/float.ts index e4793adc1..283ec0115 100644 --- a/packages/falso/src/lib/float.ts +++ b/packages/falso/src/lib/float.ts @@ -27,7 +27,10 @@ export interface RandomFloatOptions extends RandomInRangeOptions, FakeOptions {} * @example * * randFloat({ min: 10, max: 20, fraction: 2 }) // 12.52 + * + * @automaticallyGeneratedExamples */ + export function randFloat( options?: Options ) { diff --git a/packages/falso/src/lib/font-family.ts b/packages/falso/src/lib/font-family.ts index 9cc60407a..85e212ded 100644 --- a/packages/falso/src/lib/font-family.ts +++ b/packages/falso/src/lib/font-family.ts @@ -14,7 +14,10 @@ import { data } from './font-family.json'; * * randFontFamily({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFontFamily( options?: Options ) { diff --git a/packages/falso/src/lib/font-size.ts b/packages/falso/src/lib/font-size.ts index a0319d7f9..69d83e71b 100644 --- a/packages/falso/src/lib/font-size.ts +++ b/packages/falso/src/lib/font-size.ts @@ -28,7 +28,10 @@ export interface FontSizeOptions extends FakeOptions { * * randFontSize({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFontSize( options?: Options ) { diff --git a/packages/falso/src/lib/food.ts b/packages/falso/src/lib/food.ts index f7d10b318..aa9183895 100644 --- a/packages/falso/src/lib/food.ts +++ b/packages/falso/src/lib/food.ts @@ -45,7 +45,10 @@ const totalOrigins = Object.keys(data)?.length; * * randFood({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFood( options?: Options ) { diff --git a/packages/falso/src/lib/football-team.ts b/packages/falso/src/lib/football-team.ts index 5aab7e0a1..57fd577e1 100644 --- a/packages/falso/src/lib/football-team.ts +++ b/packages/falso/src/lib/football-team.ts @@ -14,7 +14,10 @@ import { data } from './football-team.json'; * * randFootballTeam({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFootballTeam( options?: Options ) { diff --git a/packages/falso/src/lib/frequency.ts b/packages/falso/src/lib/frequency.ts index 4f4742373..34a539c27 100644 --- a/packages/falso/src/lib/frequency.ts +++ b/packages/falso/src/lib/frequency.ts @@ -14,7 +14,10 @@ import { data } from './frequency.json'; * * randFrequency({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFrequency( options?: Options ) { diff --git a/packages/falso/src/lib/full-address.ts b/packages/falso/src/lib/full-address.ts index f150e3db0..236bf4e1f 100644 --- a/packages/falso/src/lib/full-address.ts +++ b/packages/falso/src/lib/full-address.ts @@ -22,7 +22,10 @@ import { AddressOptions, randAddress } from './address'; * * randFullAddress({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFullAddress( options?: Options ) { diff --git a/packages/falso/src/lib/full-name.ts b/packages/falso/src/lib/full-name.ts index 6738af3d6..952ab50bc 100644 --- a/packages/falso/src/lib/full-name.ts +++ b/packages/falso/src/lib/full-name.ts @@ -28,7 +28,10 @@ export interface NameOptions extends FakeOptions { * * randFullName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randFullName( options?: Options ) { diff --git a/packages/falso/src/lib/future-date.ts b/packages/falso/src/lib/future-date.ts index 4374bd4fe..24d848f20 100644 --- a/packages/falso/src/lib/future-date.ts +++ b/packages/falso/src/lib/future-date.ts @@ -22,7 +22,10 @@ interface FutureOptions extends FakeOptions { * * randFutureDate({ years: 10 }) // default is 1 * + * + * @automaticallyGeneratedExamples */ + export function randFutureDate( options?: Options ) { diff --git a/packages/falso/src/lib/gender.ts b/packages/falso/src/lib/gender.ts index ac1ac55dc..e1476f770 100644 --- a/packages/falso/src/lib/gender.ts +++ b/packages/falso/src/lib/gender.ts @@ -23,7 +23,10 @@ interface GenderOptions extends FakeOptions { * * randGender({ code: true }) // default is false * + * + * @automaticallyGeneratedExamples */ + export function randGender( options?: Options ) { diff --git a/packages/falso/src/lib/git-branch.ts b/packages/falso/src/lib/git-branch.ts index 0e43a4df7..f7f84397a 100644 --- a/packages/falso/src/lib/git-branch.ts +++ b/packages/falso/src/lib/git-branch.ts @@ -14,7 +14,10 @@ import { data } from './git-branch.json'; * * randGitBranch({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randGitBranch( options?: Options ) { diff --git a/packages/falso/src/lib/git-commit-entry.ts b/packages/falso/src/lib/git-commit-entry.ts index 22c7573db..dd8d29191 100644 --- a/packages/falso/src/lib/git-commit-entry.ts +++ b/packages/falso/src/lib/git-commit-entry.ts @@ -17,7 +17,10 @@ import { randGitCommitMessage } from './git-commit-message'; * * randGitCommitEntry({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randGitCommitEntry( options?: Options ) { diff --git a/packages/falso/src/lib/git-commit-message.ts b/packages/falso/src/lib/git-commit-message.ts index da6b0cb60..66f445f95 100644 --- a/packages/falso/src/lib/git-commit-message.ts +++ b/packages/falso/src/lib/git-commit-message.ts @@ -15,7 +15,10 @@ import { randWord } from './word'; * * randGitCommitMessage({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randGitCommitMessage( options?: Options ) { diff --git a/packages/falso/src/lib/git-commit-sha.ts b/packages/falso/src/lib/git-commit-sha.ts index b6fa296e0..c4457f871 100644 --- a/packages/falso/src/lib/git-commit-sha.ts +++ b/packages/falso/src/lib/git-commit-sha.ts @@ -16,7 +16,10 @@ const commitShaLen = 40; * * randGitCommitSha({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randGitCommitSha( options?: Options ) { diff --git a/packages/falso/src/lib/git-short-sha.ts b/packages/falso/src/lib/git-short-sha.ts index c24013895..bc3ac649b 100644 --- a/packages/falso/src/lib/git-short-sha.ts +++ b/packages/falso/src/lib/git-short-sha.ts @@ -16,7 +16,10 @@ const commitShortShaLen = 7; * * randGitShortSha({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randGitShortSha( options?: Options ) { diff --git a/packages/falso/src/lib/hex.ts b/packages/falso/src/lib/hex.ts index 08441917b..356beed27 100644 --- a/packages/falso/src/lib/hex.ts +++ b/packages/falso/src/lib/hex.ts @@ -14,7 +14,10 @@ import { random } from './random'; * * randHex({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randHex( options?: Options ) { diff --git a/packages/falso/src/lib/hexa-decimal.ts b/packages/falso/src/lib/hexa-decimal.ts index 32faedb87..ba58d376b 100644 --- a/packages/falso/src/lib/hexa-decimal.ts +++ b/packages/falso/src/lib/hexa-decimal.ts @@ -2,7 +2,7 @@ import { fake, FakeOptions } from './core/core'; import { randNumber } from './number'; function generator() { - return randNumber({min:0, max:15}).toString(16); + return randNumber({ min: 0, max: 15 }).toString(16); } /** @@ -18,7 +18,10 @@ function generator() { * * randHexaDecimal({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randHexaDecimal( options?: Options ) { diff --git a/packages/falso/src/lib/horse.ts b/packages/falso/src/lib/horse.ts index 2cf31fe95..605b37c2d 100644 --- a/packages/falso/src/lib/horse.ts +++ b/packages/falso/src/lib/horse.ts @@ -14,7 +14,10 @@ import { data } from './horse.json'; * * randHorse({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randHorse( options?: Options ) { diff --git a/packages/falso/src/lib/hsl.ts b/packages/falso/src/lib/hsl.ts index b880fa9ba..5fbf7cddc 100644 --- a/packages/falso/src/lib/hsl.ts +++ b/packages/falso/src/lib/hsl.ts @@ -22,7 +22,10 @@ export interface HSLOptions extends FakeOptions { * * randHsl({ alpha: true }) // default is false * + * + * @automaticallyGeneratedExamples */ + export function randHsl(options?: Options) { const factory = () => { const [h, s, l, a] = [ diff --git a/packages/falso/src/lib/http-method.ts b/packages/falso/src/lib/http-method.ts index a57a0202e..10fd798cb 100644 --- a/packages/falso/src/lib/http-method.ts +++ b/packages/falso/src/lib/http-method.ts @@ -14,7 +14,10 @@ import { data } from './http-method.json'; * * randHttpMethod({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randHttpMethod( options?: Options ) { diff --git a/packages/falso/src/lib/i18n/ar/bird.ts b/packages/falso/src/lib/i18n/ar/bird.ts index df8340150..2ef277a36 100644 --- a/packages/falso/src/lib/i18n/ar/bird.ts +++ b/packages/falso/src/lib/i18n/ar/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/i18n/es/bird.ts b/packages/falso/src/lib/i18n/es/bird.ts index df8340150..2ef277a36 100644 --- a/packages/falso/src/lib/i18n/es/bird.ts +++ b/packages/falso/src/lib/i18n/es/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/i18n/fr/bird.ts b/packages/falso/src/lib/i18n/fr/bird.ts index df8340150..2ef277a36 100644 --- a/packages/falso/src/lib/i18n/fr/bird.ts +++ b/packages/falso/src/lib/i18n/fr/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/i18n/hi/bird.ts b/packages/falso/src/lib/i18n/hi/bird.ts index df8340150..2ef277a36 100644 --- a/packages/falso/src/lib/i18n/hi/bird.ts +++ b/packages/falso/src/lib/i18n/hi/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/i18n/ru/bird.ts b/packages/falso/src/lib/i18n/ru/bird.ts index df8340150..2ef277a36 100644 --- a/packages/falso/src/lib/i18n/ru/bird.ts +++ b/packages/falso/src/lib/i18n/ru/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/i18n/se/bird.ts b/packages/falso/src/lib/i18n/se/bird.ts index df8340150..2ef277a36 100644 --- a/packages/falso/src/lib/i18n/se/bird.ts +++ b/packages/falso/src/lib/i18n/se/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/i18n/zh/bird.ts b/packages/falso/src/lib/i18n/zh/bird.ts index df8340150..2ef277a36 100644 --- a/packages/falso/src/lib/i18n/zh/bird.ts +++ b/packages/falso/src/lib/i18n/zh/bird.ts @@ -14,7 +14,10 @@ import { data } from './bird.i18n.json'; * * randBird({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randBird( options?: Options ) { diff --git a/packages/falso/src/lib/iban.ts b/packages/falso/src/lib/iban.ts index 07d9cb700..77fecb214 100644 --- a/packages/falso/src/lib/iban.ts +++ b/packages/falso/src/lib/iban.ts @@ -24,7 +24,10 @@ export interface IbanOptions extends FakeOptions { * * randIban({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randIban( options?: Options ) { diff --git a/packages/falso/src/lib/ice-hockey-team.ts b/packages/falso/src/lib/ice-hockey-team.ts index 415e3a46e..599d6cedb 100644 --- a/packages/falso/src/lib/ice-hockey-team.ts +++ b/packages/falso/src/lib/ice-hockey-team.ts @@ -14,7 +14,10 @@ import { data } from './ice-hockey-team.json'; * * randIceHockeyTeam({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randIceHockeyTeam( options?: Options ) { diff --git a/packages/falso/src/lib/img.ts b/packages/falso/src/lib/img.ts index 550576e15..1a09830e4 100644 --- a/packages/falso/src/lib/img.ts +++ b/packages/falso/src/lib/img.ts @@ -15,7 +15,10 @@ type Category = 'animals' | 'arch' | 'nature' | 'people' | 'tech'; * * randImg({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randImg< Options extends FakeOptions & { width?: number; diff --git a/packages/falso/src/lib/integration.ts b/packages/falso/src/lib/integration.ts index 1d8ec9df5..eef92a3ff 100644 --- a/packages/falso/src/lib/integration.ts +++ b/packages/falso/src/lib/integration.ts @@ -14,7 +14,10 @@ import { data } from './integration.json'; * * randIntegrations({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randIntegration( options?: Options ) { diff --git a/packages/falso/src/lib/ip.ts b/packages/falso/src/lib/ip.ts index 3d9a10990..ecc4555d6 100644 --- a/packages/falso/src/lib/ip.ts +++ b/packages/falso/src/lib/ip.ts @@ -16,7 +16,10 @@ const ipRange = { min: 0, max: 255 }; * * randIp({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randIp(options?: Options) { return fake( () => Array.from({ length: 4 }, () => randNumber(ipRange)).join('.'), diff --git a/packages/falso/src/lib/ipv6.ts b/packages/falso/src/lib/ipv6.ts index dfaebfbc7..a2ec275c2 100644 --- a/packages/falso/src/lib/ipv6.ts +++ b/packages/falso/src/lib/ipv6.ts @@ -14,7 +14,10 @@ import { randHexaDecimal } from './hexa-decimal'; * * randIpv6({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randIpv6( options?: Options ) { diff --git a/packages/falso/src/lib/job-area.ts b/packages/falso/src/lib/job-area.ts index 99d566e6d..4a4968af6 100644 --- a/packages/falso/src/lib/job-area.ts +++ b/packages/falso/src/lib/job-area.ts @@ -14,7 +14,10 @@ import { data } from './job-area.json'; * * randJobArea({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randJobArea( options?: Options ) { diff --git a/packages/falso/src/lib/job-descriptor.ts b/packages/falso/src/lib/job-descriptor.ts index 053e67021..9e3a42b2e 100644 --- a/packages/falso/src/lib/job-descriptor.ts +++ b/packages/falso/src/lib/job-descriptor.ts @@ -14,7 +14,10 @@ import { data } from './job-descriptor.json'; * * randJobDescriptor({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randJobDescriptor( options?: Options ) { diff --git a/packages/falso/src/lib/job-title.ts b/packages/falso/src/lib/job-title.ts index c0553878b..444c34a74 100644 --- a/packages/falso/src/lib/job-title.ts +++ b/packages/falso/src/lib/job-title.ts @@ -14,7 +14,10 @@ import { data } from './job-title.json'; * * randJobTitle({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randJobTitle( options?: Options ) { diff --git a/packages/falso/src/lib/job-type.ts b/packages/falso/src/lib/job-type.ts index 7907de9a1..d90326818 100644 --- a/packages/falso/src/lib/job-type.ts +++ b/packages/falso/src/lib/job-type.ts @@ -14,7 +14,10 @@ import { data } from './job-type.json'; * * randJobType({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randJobType( options?: Options ) { diff --git a/packages/falso/src/lib/json.ts b/packages/falso/src/lib/json.ts index 779fa30ae..e6df53bae 100644 --- a/packages/falso/src/lib/json.ts +++ b/packages/falso/src/lib/json.ts @@ -67,7 +67,10 @@ const generateRandomValue = (): any => { * * randJSON({ minKeys: 1, maxKeys: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randJSON( options?: Options ) { diff --git a/packages/falso/src/lib/language.ts b/packages/falso/src/lib/language.ts index e32436fb8..cb4ac0498 100644 --- a/packages/falso/src/lib/language.ts +++ b/packages/falso/src/lib/language.ts @@ -23,7 +23,10 @@ interface LanguageOptions extends FakeOptions { * * randLanguage({ code: true }) // default is false * + * + * @automaticallyGeneratedExamples */ + export function randLanguage( options?: Options ) { diff --git a/packages/falso/src/lib/last-name.ts b/packages/falso/src/lib/last-name.ts index 0ff755d50..28512f648 100644 --- a/packages/falso/src/lib/last-name.ts +++ b/packages/falso/src/lib/last-name.ts @@ -20,7 +20,10 @@ import { NameOptions } from './full-name'; * * randLastName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randLastName( options?: Options ) { diff --git a/packages/falso/src/lib/latitude.ts b/packages/falso/src/lib/latitude.ts index 16411fd26..fac129292 100644 --- a/packages/falso/src/lib/latitude.ts +++ b/packages/falso/src/lib/latitude.ts @@ -13,7 +13,10 @@ import { FakeOptions, fake, getRandomInRange } from './core/core'; * * randLatitude({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randLatitude( options?: Options ) { diff --git a/packages/falso/src/lib/line.ts b/packages/falso/src/lib/line.ts index 42ff0ab99..5ae9cb030 100644 --- a/packages/falso/src/lib/line.ts +++ b/packages/falso/src/lib/line.ts @@ -18,7 +18,10 @@ export interface LineOptions extends FakeOptions { * * randLine({ lineCount: 10 }) // default is 5 * + * + * @automaticallyGeneratedExamples */ + export function randLine( options?: Options ) { diff --git a/packages/falso/src/lib/lines.ts b/packages/falso/src/lib/lines.ts index a09bc6705..38f38237e 100644 --- a/packages/falso/src/lib/lines.ts +++ b/packages/falso/src/lib/lines.ts @@ -14,7 +14,10 @@ import { data } from './lines.json'; * * randLines({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randLines( options?: Options ) { diff --git a/packages/falso/src/lib/lion.ts b/packages/falso/src/lib/lion.ts index 791099481..c4287ab01 100644 --- a/packages/falso/src/lib/lion.ts +++ b/packages/falso/src/lib/lion.ts @@ -14,7 +14,10 @@ import { data } from './lion.json'; * * randLion({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randLion( options?: Options ) { diff --git a/packages/falso/src/lib/locale.ts b/packages/falso/src/lib/locale.ts index 481e5f084..e05d695a2 100644 --- a/packages/falso/src/lib/locale.ts +++ b/packages/falso/src/lib/locale.ts @@ -14,7 +14,10 @@ import { data } from './locale.json'; * * randLocale({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randLocale( options?: Options ) { diff --git a/packages/falso/src/lib/longitude.ts b/packages/falso/src/lib/longitude.ts index e9802e30c..c8422f9a1 100644 --- a/packages/falso/src/lib/longitude.ts +++ b/packages/falso/src/lib/longitude.ts @@ -13,7 +13,10 @@ import { FakeOptions, fake, getRandomInRange } from './core/core'; * * randLongitude({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randLongitude( options?: Options ) { diff --git a/packages/falso/src/lib/mac.ts b/packages/falso/src/lib/mac.ts index bd2d33d49..f36791aca 100644 --- a/packages/falso/src/lib/mac.ts +++ b/packages/falso/src/lib/mac.ts @@ -14,7 +14,10 @@ import { randHexaDecimal } from './hexa-decimal'; * * randMac({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randMac( options?: Options ) { diff --git a/packages/falso/src/lib/mask.ts b/packages/falso/src/lib/mask.ts index 1c1f7102c..a6ac4b42d 100644 --- a/packages/falso/src/lib/mask.ts +++ b/packages/falso/src/lib/mask.ts @@ -18,7 +18,10 @@ import { randAlpha } from './alpha'; * * randMask({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randMask< Options extends FakeOptions & { mask?: string; diff --git a/packages/falso/src/lib/mime-type.ts b/packages/falso/src/lib/mime-type.ts index ced906cbe..4516233ac 100644 --- a/packages/falso/src/lib/mime-type.ts +++ b/packages/falso/src/lib/mime-type.ts @@ -14,7 +14,10 @@ import { data } from './mime-type.json'; * * randMimeType({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randMimeType( options?: Options ) { diff --git a/packages/falso/src/lib/month.ts b/packages/falso/src/lib/month.ts index 9ab5d9f76..1a20a877d 100644 --- a/packages/falso/src/lib/month.ts +++ b/packages/falso/src/lib/month.ts @@ -22,7 +22,10 @@ export interface MonthOptions extends FakeOptions { * * randMonth({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randMonth( options?: Options ) { diff --git a/packages/falso/src/lib/movie-character.ts b/packages/falso/src/lib/movie-character.ts index 13de7a6ad..a83e522a1 100644 --- a/packages/falso/src/lib/movie-character.ts +++ b/packages/falso/src/lib/movie-character.ts @@ -13,7 +13,10 @@ import { data } from './movie-character.json'; * * randMovieCharacter({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randMovieCharacter( options?: Options ) { diff --git a/packages/falso/src/lib/movie.ts b/packages/falso/src/lib/movie.ts index 89a0e1e31..ddac722cc 100644 --- a/packages/falso/src/lib/movie.ts +++ b/packages/falso/src/lib/movie.ts @@ -13,7 +13,10 @@ import { data } from './movie.json'; * * randMovie({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randMovie( options?: Options ) { diff --git a/packages/falso/src/lib/music-genre.ts b/packages/falso/src/lib/music-genre.ts index a2ce1ef8f..ccc036c2f 100644 --- a/packages/falso/src/lib/music-genre.ts +++ b/packages/falso/src/lib/music-genre.ts @@ -14,7 +14,10 @@ import { data } from './music-genre.json'; * * randMusicGenre({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randMusicGenre( options?: Options ) { diff --git a/packages/falso/src/lib/nearby-gpscoordinate.ts b/packages/falso/src/lib/nearby-gpscoordinate.ts index a37f3d3f5..894cb48b3 100644 --- a/packages/falso/src/lib/nearby-gpscoordinate.ts +++ b/packages/falso/src/lib/nearby-gpscoordinate.ts @@ -15,7 +15,10 @@ import { randLongitude } from './longitude'; * * randNearbyGPSCoordinate({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randNearbyGPSCoordinate( options?: Options ) { diff --git a/packages/falso/src/lib/number.ts b/packages/falso/src/lib/number.ts index 50bd1c204..21ef1e54c 100644 --- a/packages/falso/src/lib/number.ts +++ b/packages/falso/src/lib/number.ts @@ -43,7 +43,10 @@ export interface RandomNumberOptions extends RandomInRangeOptions, FakeOptions { * @example * * randNumber({ min: 1000, max: 2000, precision: 10 }) // 1_250 + * + * @automaticallyGeneratedExamples */ + export function randNumber( options?: Options ) { diff --git a/packages/falso/src/lib/oauth-provider.ts b/packages/falso/src/lib/oauth-provider.ts index e6eca46fa..fa1817923 100644 --- a/packages/falso/src/lib/oauth-provider.ts +++ b/packages/falso/src/lib/oauth-provider.ts @@ -14,7 +14,10 @@ import { data } from './oauth-provider.json'; * * randOAuthProvider({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randOAuthProvider( options?: Options ) { diff --git a/packages/falso/src/lib/octal.ts b/packages/falso/src/lib/octal.ts index 93d92ed16..c4f5343f5 100644 --- a/packages/falso/src/lib/octal.ts +++ b/packages/falso/src/lib/octal.ts @@ -13,7 +13,10 @@ import { fake, FakeOptions } from './core/core'; * * randOctal({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randOctal( options?: Options ) { diff --git a/packages/falso/src/lib/ordinal-direction.ts b/packages/falso/src/lib/ordinal-direction.ts index 0db1a03da..3baee2d54 100644 --- a/packages/falso/src/lib/ordinal-direction.ts +++ b/packages/falso/src/lib/ordinal-direction.ts @@ -14,7 +14,10 @@ import { data } from './ordinal-direction.json'; * * randOrdinalDirection({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randOrdinalDirection( options?: Options ) { diff --git a/packages/falso/src/lib/paragraph.ts b/packages/falso/src/lib/paragraph.ts index 1c2a4f6a6..21134537f 100644 --- a/packages/falso/src/lib/paragraph.ts +++ b/packages/falso/src/lib/paragraph.ts @@ -14,7 +14,10 @@ import { data } from './paragraph.json'; * * randJobTitle({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randParagraph( options?: Options ) { diff --git a/packages/falso/src/lib/password.ts b/packages/falso/src/lib/password.ts index 8120cfa8b..e841866f5 100644 --- a/packages/falso/src/lib/password.ts +++ b/packages/falso/src/lib/password.ts @@ -22,7 +22,10 @@ export interface PasswordOptions extends FakeOptions { * * randPassword({ size: 10 }) // default is 15 * + * + * @automaticallyGeneratedExamples */ + export function randPassword( options?: Options ) { diff --git a/packages/falso/src/lib/past-date.ts b/packages/falso/src/lib/past-date.ts index abc6b8ee9..39bc01a46 100644 --- a/packages/falso/src/lib/past-date.ts +++ b/packages/falso/src/lib/past-date.ts @@ -22,7 +22,10 @@ interface PastOptions extends FakeOptions { * * randPastDate({ years: 2 }) // default is 1 * + * + * @automaticallyGeneratedExamples */ + export function randPastDate( options?: Options ) { diff --git a/packages/falso/src/lib/permission.ts b/packages/falso/src/lib/permission.ts index fb64021ca..b6666e048 100644 --- a/packages/falso/src/lib/permission.ts +++ b/packages/falso/src/lib/permission.ts @@ -22,7 +22,10 @@ interface PermissionOptions extends FakeOptions { * * randPermission({ numeric: true }) * + * + * @automaticallyGeneratedExamples */ + export function randPermission( options?: Options ) { diff --git a/packages/falso/src/lib/person-title.ts b/packages/falso/src/lib/person-title.ts index 0a7b4be26..506f46cf2 100644 --- a/packages/falso/src/lib/person-title.ts +++ b/packages/falso/src/lib/person-title.ts @@ -14,7 +14,10 @@ import { data } from './person-title.json'; * * randPersonTitle({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randPersonTitle( options?: Options ) { diff --git a/packages/falso/src/lib/phone-number.ts b/packages/falso/src/lib/phone-number.ts index b9864fe67..09b22fc39 100644 --- a/packages/falso/src/lib/phone-number.ts +++ b/packages/falso/src/lib/phone-number.ts @@ -252,7 +252,10 @@ type CountryCode = * * randPhoneNumber({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randPhoneNumber< Options extends FakeOptions & { countryCode?: CountryCode; diff --git a/packages/falso/src/lib/phrase.ts b/packages/falso/src/lib/phrase.ts index 620e2f778..d1adecd08 100644 --- a/packages/falso/src/lib/phrase.ts +++ b/packages/falso/src/lib/phrase.ts @@ -14,7 +14,10 @@ import { data } from './phrase.json'; * * randPhrase({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randPhrase( options?: Options ) { diff --git a/packages/falso/src/lib/port.ts b/packages/falso/src/lib/port.ts index ab556f201..8263e1a93 100644 --- a/packages/falso/src/lib/port.ts +++ b/packages/falso/src/lib/port.ts @@ -14,7 +14,10 @@ import { randNumber } from './number'; * * randPort({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randPort( options?: Options ) { diff --git a/packages/falso/src/lib/post.ts b/packages/falso/src/lib/post.ts index 648053b27..7d04f579f 100644 --- a/packages/falso/src/lib/post.ts +++ b/packages/falso/src/lib/post.ts @@ -24,7 +24,10 @@ export interface Post { * * randPost({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randPost( options?: Options ) { diff --git a/packages/falso/src/lib/priority.ts b/packages/falso/src/lib/priority.ts index 467ce7fcd..5d2027cf1 100644 --- a/packages/falso/src/lib/priority.ts +++ b/packages/falso/src/lib/priority.ts @@ -14,7 +14,10 @@ import { data } from './priority.json'; * * randPriority({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randPriority( options?: Options ) { diff --git a/packages/falso/src/lib/product-adjective.ts b/packages/falso/src/lib/product-adjective.ts index d457afc31..2db2ae877 100644 --- a/packages/falso/src/lib/product-adjective.ts +++ b/packages/falso/src/lib/product-adjective.ts @@ -14,7 +14,10 @@ import { data } from './product-adjective.json'; * * randProductAdjective({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randProductAdjective( options?: Options ) { diff --git a/packages/falso/src/lib/product-category.ts b/packages/falso/src/lib/product-category.ts index 15c2fa446..f117be640 100644 --- a/packages/falso/src/lib/product-category.ts +++ b/packages/falso/src/lib/product-category.ts @@ -14,7 +14,10 @@ import { data } from './product-category.json'; * * randProductCategory({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randProductCategory( options?: Options ) { diff --git a/packages/falso/src/lib/product-description.ts b/packages/falso/src/lib/product-description.ts index 8e9b8dc50..f5b6e5622 100644 --- a/packages/falso/src/lib/product-description.ts +++ b/packages/falso/src/lib/product-description.ts @@ -14,7 +14,10 @@ import { data } from './product-description.json'; * * randProductDescription({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randProductDescription( options?: Options ) { diff --git a/packages/falso/src/lib/product-material.ts b/packages/falso/src/lib/product-material.ts index 2faca0141..b77b3a1b8 100644 --- a/packages/falso/src/lib/product-material.ts +++ b/packages/falso/src/lib/product-material.ts @@ -14,7 +14,10 @@ import { data } from './product-material.json'; * * randProductMaterial({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randProductMaterial( options?: Options ) { diff --git a/packages/falso/src/lib/product-name.ts b/packages/falso/src/lib/product-name.ts index 265f51430..cdf4efb1e 100644 --- a/packages/falso/src/lib/product-name.ts +++ b/packages/falso/src/lib/product-name.ts @@ -14,7 +14,10 @@ import { data } from './product-name.json'; * * randProductName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randProductName( options?: Options ) { diff --git a/packages/falso/src/lib/product.ts b/packages/falso/src/lib/product.ts index 4f393805b..b9a38cf8b 100644 --- a/packages/falso/src/lib/product.ts +++ b/packages/falso/src/lib/product.ts @@ -31,7 +31,10 @@ export interface Product { * * randProduct({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randProduct( options?: Options ) { diff --git a/packages/falso/src/lib/programming-language.ts b/packages/falso/src/lib/programming-language.ts index 051d86f96..a55dd137f 100644 --- a/packages/falso/src/lib/programming-language.ts +++ b/packages/falso/src/lib/programming-language.ts @@ -14,7 +14,10 @@ import { data } from './programming-language.json'; * * randProgrammingLanguage({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randProgrammingLanguage( options?: Options ) { diff --git a/packages/falso/src/lib/pronoun.ts b/packages/falso/src/lib/pronoun.ts index 5c46a59bc..c520d3fe7 100644 --- a/packages/falso/src/lib/pronoun.ts +++ b/packages/falso/src/lib/pronoun.ts @@ -10,7 +10,10 @@ import { data } from './pronoun.json'; * * randPronoun() * + * + * @automaticallyGeneratedExamples */ + export function randPronoun( options?: Options ) { diff --git a/packages/falso/src/lib/protocol.ts b/packages/falso/src/lib/protocol.ts index 2a91d31b9..a16c3e8c6 100644 --- a/packages/falso/src/lib/protocol.ts +++ b/packages/falso/src/lib/protocol.ts @@ -23,7 +23,10 @@ interface ProtocolOptions extends FakeOptions { * * randProtocol({ fullName: true }) * + * + * @automaticallyGeneratedExamples */ + export function randProtocol( options?: Options ) { diff --git a/packages/falso/src/lib/quote.ts b/packages/falso/src/lib/quote.ts index c12fc5846..dcf6cba11 100644 --- a/packages/falso/src/lib/quote.ts +++ b/packages/falso/src/lib/quote.ts @@ -14,7 +14,10 @@ import { data } from './quote.json'; * * randQuote({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randQuote( options?: Options ) { diff --git a/packages/falso/src/lib/rabbit.ts b/packages/falso/src/lib/rabbit.ts index fb6a83502..7782e8648 100644 --- a/packages/falso/src/lib/rabbit.ts +++ b/packages/falso/src/lib/rabbit.ts @@ -14,7 +14,10 @@ import { data } from './rabbit.json'; * * randRabbit({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randRabbit( options?: Options ) { diff --git a/packages/falso/src/lib/rand.ts b/packages/falso/src/lib/rand.ts index 4ae0747e4..ef3164623 100644 --- a/packages/falso/src/lib/rand.ts +++ b/packages/falso/src/lib/rand.ts @@ -13,7 +13,10 @@ import { fake, FakeOptions } from './core/core'; * * rand([ 1, 2, 3 ], { length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function rand( arr: Readonly, options?: Options diff --git a/packages/falso/src/lib/random.ts b/packages/falso/src/lib/random.ts index 5f9d7c61c..4d056eae5 100644 --- a/packages/falso/src/lib/random.ts +++ b/packages/falso/src/lib/random.ts @@ -11,7 +11,10 @@ let prng = seedRandom(); * * random() * + * + * @automaticallyGeneratedExamples */ + export function random() { return prng(); } @@ -28,7 +31,9 @@ export function random() { * @example * * seed('some-constant-seed') + * */ + export function seed(value?: string) { prng = seedRandom(value); } diff --git a/packages/falso/src/lib/recent-date.ts b/packages/falso/src/lib/recent-date.ts index dda73db0a..b624b9bad 100644 --- a/packages/falso/src/lib/recent-date.ts +++ b/packages/falso/src/lib/recent-date.ts @@ -22,7 +22,10 @@ interface RecentOptions extends FakeOptions { * * randRecentDate({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randRecentDate( options?: Options ) { diff --git a/packages/falso/src/lib/rgb.ts b/packages/falso/src/lib/rgb.ts index 3e4f8055c..e79e38178 100644 --- a/packages/falso/src/lib/rgb.ts +++ b/packages/falso/src/lib/rgb.ts @@ -22,7 +22,10 @@ export interface RGBOptions extends FakeOptions { * * randRgb({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randRgb(options?: Options) { const factory = () => { const [r, g, b, a] = [ diff --git a/packages/falso/src/lib/role.ts b/packages/falso/src/lib/role.ts index 54e9737ae..079311fe8 100644 --- a/packages/falso/src/lib/role.ts +++ b/packages/falso/src/lib/role.ts @@ -14,7 +14,10 @@ import { data } from './role.json'; * * randRole({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randRole( options?: Options ) { diff --git a/packages/falso/src/lib/routing-number.ts b/packages/falso/src/lib/routing-number.ts index 59be1c061..64d493cb1 100644 --- a/packages/falso/src/lib/routing-number.ts +++ b/packages/falso/src/lib/routing-number.ts @@ -14,7 +14,10 @@ import { randNumber } from './number'; * * randRoutingNumber({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randRoutingNumber( options?: Options ) { diff --git a/packages/falso/src/lib/seat-number.ts b/packages/falso/src/lib/seat-number.ts index cc702c5a1..055986099 100644 --- a/packages/falso/src/lib/seat-number.ts +++ b/packages/falso/src/lib/seat-number.ts @@ -14,7 +14,10 @@ import { rand } from './rand'; * * randSeatNumber({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSeatNumber( options?: Options ) { diff --git a/packages/falso/src/lib/semver.ts b/packages/falso/src/lib/semver.ts index 02bf8bfaf..d74d6b2d4 100644 --- a/packages/falso/src/lib/semver.ts +++ b/packages/falso/src/lib/semver.ts @@ -22,7 +22,10 @@ export interface SemverOptions extends FakeOptions { * * randSemver({ prefix: 'v' }) * + * + * @automaticallyGeneratedExamples */ + export function randSemver( options?: Options ) { diff --git a/packages/falso/src/lib/sentence.ts b/packages/falso/src/lib/sentence.ts index 98368010b..2d0c998fa 100644 --- a/packages/falso/src/lib/sentence.ts +++ b/packages/falso/src/lib/sentence.ts @@ -30,7 +30,10 @@ function getSpecialCharacter(wordCount: number): string { * * randSentence({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSentence( options?: Options ) { diff --git a/packages/falso/src/lib/sequence.ts b/packages/falso/src/lib/sequence.ts index 77f51b4bf..59f015f08 100644 --- a/packages/falso/src/lib/sequence.ts +++ b/packages/falso/src/lib/sequence.ts @@ -51,7 +51,10 @@ type RandomSequenceOptions2 = { * * randSequence({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSequence( options?: RandomSequenceOptions ): Return; diff --git a/packages/falso/src/lib/shape.ts b/packages/falso/src/lib/shape.ts index b46cc0ae0..1f021f3a1 100644 --- a/packages/falso/src/lib/shape.ts +++ b/packages/falso/src/lib/shape.ts @@ -14,7 +14,10 @@ import { data } from './shape.json'; * * randShape({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randShape( options?: Options ) { diff --git a/packages/falso/src/lib/singer.ts b/packages/falso/src/lib/singer.ts index 5b3db23ee..719551ffc 100644 --- a/packages/falso/src/lib/singer.ts +++ b/packages/falso/src/lib/singer.ts @@ -13,7 +13,10 @@ import { data } from './singer.json'; * * randSinger({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSinger( options?: Options ) { diff --git a/packages/falso/src/lib/skill.ts b/packages/falso/src/lib/skill.ts index 196ca01da..9caf3a3f0 100644 --- a/packages/falso/src/lib/skill.ts +++ b/packages/falso/src/lib/skill.ts @@ -14,7 +14,10 @@ import { data } from './skill.json'; * * randSkill({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSkill( options?: Options ) { diff --git a/packages/falso/src/lib/slug.ts b/packages/falso/src/lib/slug.ts index 551081731..e14c07f9c 100644 --- a/packages/falso/src/lib/slug.ts +++ b/packages/falso/src/lib/slug.ts @@ -14,7 +14,10 @@ import { randWord } from './word'; * * randSlug({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSlug( options?: Options ) { diff --git a/packages/falso/src/lib/snake.ts b/packages/falso/src/lib/snake.ts index d00bcc2e7..e4467a0fd 100644 --- a/packages/falso/src/lib/snake.ts +++ b/packages/falso/src/lib/snake.ts @@ -14,7 +14,10 @@ import { data } from './snake.json'; * * randSnake({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSnake( options?: Options ) { diff --git a/packages/falso/src/lib/song.ts b/packages/falso/src/lib/song.ts index 2df7cef98..c005ec265 100644 --- a/packages/falso/src/lib/song.ts +++ b/packages/falso/src/lib/song.ts @@ -13,7 +13,10 @@ import { data } from './song.json'; * * randSong({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSong( options?: Options ) { diff --git a/packages/falso/src/lib/soon-date.ts b/packages/falso/src/lib/soon-date.ts index fd53303f9..8eb4ab559 100644 --- a/packages/falso/src/lib/soon-date.ts +++ b/packages/falso/src/lib/soon-date.ts @@ -22,7 +22,10 @@ interface SoonOptions extends FakeOptions { * * randSoonDate({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSoonDate( options?: Options ) { diff --git a/packages/falso/src/lib/sports-team.ts b/packages/falso/src/lib/sports-team.ts index 1b7195dd6..b1382e18b 100644 --- a/packages/falso/src/lib/sports-team.ts +++ b/packages/falso/src/lib/sports-team.ts @@ -18,7 +18,10 @@ import { randIceHockeyTeam } from './ice-hockey-team'; * * randSportsTeam({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSportsTeam( options?: Options ) { diff --git a/packages/falso/src/lib/sports.ts b/packages/falso/src/lib/sports.ts index 41581d905..6b028062e 100644 --- a/packages/falso/src/lib/sports.ts +++ b/packages/falso/src/lib/sports.ts @@ -25,7 +25,10 @@ const categoriesCount = Object.keys(data)?.length; * * randSports({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSports( options?: Options ) { diff --git a/packages/falso/src/lib/state-abbr.ts b/packages/falso/src/lib/state-abbr.ts index 79b50ce74..46a67aae0 100644 --- a/packages/falso/src/lib/state-abbr.ts +++ b/packages/falso/src/lib/state-abbr.ts @@ -14,7 +14,10 @@ import { data } from './state-abbr.json'; * * randStateAbbr({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randStateAbbr( options?: Options ) { diff --git a/packages/falso/src/lib/state.ts b/packages/falso/src/lib/state.ts index a319e8343..0ca7e8dae 100644 --- a/packages/falso/src/lib/state.ts +++ b/packages/falso/src/lib/state.ts @@ -14,7 +14,10 @@ import { data } from './state.json'; * * randState({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randState( options?: Options ) { diff --git a/packages/falso/src/lib/street-address.ts b/packages/falso/src/lib/street-address.ts index 6cec0eaa4..9f02acca9 100644 --- a/packages/falso/src/lib/street-address.ts +++ b/packages/falso/src/lib/street-address.ts @@ -15,7 +15,10 @@ import { randStreetName } from './street-name'; * * randStreetAddress({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randStreetAddress( options?: Options ) { diff --git a/packages/falso/src/lib/street-name.ts b/packages/falso/src/lib/street-name.ts index df93c3f12..e505dd585 100644 --- a/packages/falso/src/lib/street-name.ts +++ b/packages/falso/src/lib/street-name.ts @@ -14,7 +14,10 @@ import { data } from './street-name.json'; * * randStreetName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randStreetName( options?: Options ) { diff --git a/packages/falso/src/lib/subscription-plan.ts b/packages/falso/src/lib/subscription-plan.ts index 207b3b697..e65c3ddf3 100644 --- a/packages/falso/src/lib/subscription-plan.ts +++ b/packages/falso/src/lib/subscription-plan.ts @@ -14,7 +14,10 @@ import { data } from './subscription-plan.json'; * * randSubscriptionPlan({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSubscriptionPlan( options?: Options ) { diff --git a/packages/falso/src/lib/superhero-name.ts b/packages/falso/src/lib/superhero-name.ts index 54271534c..19ecd5d89 100644 --- a/packages/falso/src/lib/superhero-name.ts +++ b/packages/falso/src/lib/superhero-name.ts @@ -19,7 +19,10 @@ import { data } from './superhero.json'; * * randSuperheroName({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSuperheroName( options?: Options ) { diff --git a/packages/falso/src/lib/superhero.ts b/packages/falso/src/lib/superhero.ts index fa029cf90..250b881b0 100644 --- a/packages/falso/src/lib/superhero.ts +++ b/packages/falso/src/lib/superhero.ts @@ -35,7 +35,10 @@ export interface SuperheroEntity extends Superhero { * * randSuperhero({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSuperhero( options?: Options ) { diff --git a/packages/falso/src/lib/svg.ts b/packages/falso/src/lib/svg.ts index 523ee5a43..9ecbd1fd3 100644 --- a/packages/falso/src/lib/svg.ts +++ b/packages/falso/src/lib/svg.ts @@ -14,7 +14,10 @@ import { data } from './svg.json'; * * randSvg({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSvg( options?: Options ) { diff --git a/packages/falso/src/lib/swift.ts b/packages/falso/src/lib/swift.ts index 3183972ef..a981b4f23 100644 --- a/packages/falso/src/lib/swift.ts +++ b/packages/falso/src/lib/swift.ts @@ -44,7 +44,10 @@ export interface SwiftOptions extends FakeOptions { * * randSwift({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randSwift( options?: Options ) { diff --git a/packages/falso/src/lib/text-range.ts b/packages/falso/src/lib/text-range.ts index 8ac4b70bc..21c41f6eb 100644 --- a/packages/falso/src/lib/text-range.ts +++ b/packages/falso/src/lib/text-range.ts @@ -19,7 +19,10 @@ export interface TextRangeOptions extends FakeOptions { * * randTextRange({ min: 10, max: 100, length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randTextRange( options: Options ) { diff --git a/packages/falso/src/lib/text.ts b/packages/falso/src/lib/text.ts index 4dc2691e8..b90ce727a 100644 --- a/packages/falso/src/lib/text.ts +++ b/packages/falso/src/lib/text.ts @@ -23,7 +23,10 @@ export interface TextOptions extends FakeOptions { * * randText({ charCount: 10 }) // default is 10 * + * + * @automaticallyGeneratedExamples */ + export function randText( options?: Options ) { diff --git a/packages/falso/src/lib/time-zone.ts b/packages/falso/src/lib/time-zone.ts index 66922a489..aff2fc946 100644 --- a/packages/falso/src/lib/time-zone.ts +++ b/packages/falso/src/lib/time-zone.ts @@ -14,7 +14,10 @@ import { data } from './time-zone.json'; * * randTimeZone({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randTimeZone( options?: Options ) { diff --git a/packages/falso/src/lib/todo.ts b/packages/falso/src/lib/todo.ts index 4cf0c51fc..51a285b99 100644 --- a/packages/falso/src/lib/todo.ts +++ b/packages/falso/src/lib/todo.ts @@ -22,7 +22,10 @@ export interface Todo { * * randTodo({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randTodo( options?: Options ) { diff --git a/packages/falso/src/lib/transaction-type.ts b/packages/falso/src/lib/transaction-type.ts index 3d430d94c..359644778 100644 --- a/packages/falso/src/lib/transaction-type.ts +++ b/packages/falso/src/lib/transaction-type.ts @@ -14,7 +14,10 @@ import { data } from './transaction-type.json'; * * randTransactionType({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randTransactionType( options?: Options ) { diff --git a/packages/falso/src/lib/url.ts b/packages/falso/src/lib/url.ts index f122cdcf8..f1563d7a6 100644 --- a/packages/falso/src/lib/url.ts +++ b/packages/falso/src/lib/url.ts @@ -15,7 +15,10 @@ import { randWord } from './word'; * * randUrl({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randUrl( options?: Options ) { diff --git a/packages/falso/src/lib/user-agent.ts b/packages/falso/src/lib/user-agent.ts index 8cfb40c3b..b1cb319ba 100644 --- a/packages/falso/src/lib/user-agent.ts +++ b/packages/falso/src/lib/user-agent.ts @@ -14,7 +14,10 @@ import { data } from './user-agent.json'; * * randUserAgent({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randUserAgent( options?: Options ) { diff --git a/packages/falso/src/lib/user-name.ts b/packages/falso/src/lib/user-name.ts index e005a45fb..7b6cd67fa 100644 --- a/packages/falso/src/lib/user-name.ts +++ b/packages/falso/src/lib/user-name.ts @@ -30,7 +30,10 @@ export interface UserNameOptions extends FakeOptions { * * randUserName({ lastName: 'Smee' }) * + * + * @automaticallyGeneratedExamples */ + export function randUserName( options?: Options ) { diff --git a/packages/falso/src/lib/user.ts b/packages/falso/src/lib/user.ts index ca300b948..eaad3e46a 100644 --- a/packages/falso/src/lib/user.ts +++ b/packages/falso/src/lib/user.ts @@ -36,7 +36,10 @@ export interface User { * * randUser({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randUser( options?: Options ) { diff --git a/packages/falso/src/lib/uuid.ts b/packages/falso/src/lib/uuid.ts index 5af6110dd..7e67441d1 100644 --- a/packages/falso/src/lib/uuid.ts +++ b/packages/falso/src/lib/uuid.ts @@ -15,7 +15,10 @@ import { randNumber } from './number'; * * randUuid({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randUuid( options?: Options ) { diff --git a/packages/falso/src/lib/vehicle-fuel.ts b/packages/falso/src/lib/vehicle-fuel.ts index e6f06a30a..a18727e98 100644 --- a/packages/falso/src/lib/vehicle-fuel.ts +++ b/packages/falso/src/lib/vehicle-fuel.ts @@ -14,7 +14,10 @@ import { data } from './vehicle-fuel.json'; * * randVehicleFuel({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randVehicleFuel( options?: Options ) { diff --git a/packages/falso/src/lib/vehicle-manufacturer.ts b/packages/falso/src/lib/vehicle-manufacturer.ts index 0b5c12568..f3f2fc4b8 100644 --- a/packages/falso/src/lib/vehicle-manufacturer.ts +++ b/packages/falso/src/lib/vehicle-manufacturer.ts @@ -14,7 +14,10 @@ import { data } from './vehicle-manufacturer.json'; * * randVehicleManufacturer({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randVehicleManufacturer( options?: Options ) { diff --git a/packages/falso/src/lib/vehicle-model.ts b/packages/falso/src/lib/vehicle-model.ts index cfb4540e6..8850d36da 100644 --- a/packages/falso/src/lib/vehicle-model.ts +++ b/packages/falso/src/lib/vehicle-model.ts @@ -14,7 +14,10 @@ import { data } from './vehicle-model.json'; * * randVehicleModel({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randVehicleModel( options?: Options ) { diff --git a/packages/falso/src/lib/vehicle-type.ts b/packages/falso/src/lib/vehicle-type.ts index 7252c71cb..e375f5cb6 100644 --- a/packages/falso/src/lib/vehicle-type.ts +++ b/packages/falso/src/lib/vehicle-type.ts @@ -14,7 +14,10 @@ import { data } from './vehicle-type.json'; * * randVehicleType({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randVehicleType( options?: Options ) { diff --git a/packages/falso/src/lib/vehicle.ts b/packages/falso/src/lib/vehicle.ts index 82aa28a3b..aae2751f7 100644 --- a/packages/falso/src/lib/vehicle.ts +++ b/packages/falso/src/lib/vehicle.ts @@ -14,7 +14,10 @@ import { data } from './vehicle.json'; * * randVehicle({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randVehicle( options?: Options ) { diff --git a/packages/falso/src/lib/verb.ts b/packages/falso/src/lib/verb.ts index 830f9d010..78ff769ba 100644 --- a/packages/falso/src/lib/verb.ts +++ b/packages/falso/src/lib/verb.ts @@ -14,7 +14,10 @@ import { data } from './verb.json'; * * randVerb({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randVerb( options?: Options ) { diff --git a/packages/falso/src/lib/weekday.ts b/packages/falso/src/lib/weekday.ts index c81273b1e..25fc684c9 100644 --- a/packages/falso/src/lib/weekday.ts +++ b/packages/falso/src/lib/weekday.ts @@ -14,7 +14,10 @@ import { data } from './weekday.json'; * * randWeekday({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randWeekday( options?: Options ) { diff --git a/packages/falso/src/lib/word.ts b/packages/falso/src/lib/word.ts index 3406c2d90..1fef78e5a 100644 --- a/packages/falso/src/lib/word.ts +++ b/packages/falso/src/lib/word.ts @@ -26,7 +26,10 @@ function capitalizeFirstLetter(text: string): string { * * randWord({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randWord( options?: Options ) { diff --git a/packages/falso/src/lib/zip-code.ts b/packages/falso/src/lib/zip-code.ts index 5432bbf49..aac2e316c 100644 --- a/packages/falso/src/lib/zip-code.ts +++ b/packages/falso/src/lib/zip-code.ts @@ -15,7 +15,10 @@ import { randBoolean } from './boolean'; * * randZipCode({ length: 10 }) * + * + * @automaticallyGeneratedExamples */ + export function randZipCode( options?: Options ) {