feat: generate

ngneat · Jul 19, 2022 · c2792d2 · c2792d2
1 parent 80ffac6
commit c2792d2
Show file tree

Hide file tree

Showing 156 changed files with 632 additions and 28 deletions.
diff --git a/packages/falso/src/lib/accessory.ts b/packages/falso/src/lib/accessory.ts
@@ -16,6 +16,10 @@ import { data } from './accessory.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Sunglasses
+ * Apron
+ * Necklace
  */
 
 export function randAccessory<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/account.ts b/packages/falso/src/lib/account.ts
@@ -23,9 +23,9 @@ export interface AccountOptions extends FakeOptions {
  *
  * @automaticallyGeneratedExamples
  * @example
- * 473138897
- * 937452680
- * 108248170
+ * 316396831
+ * 336461842
+ * 864320942
  */
 
 export function randAccount<Options extends AccountOptions = never>(

diff --git a/packages/falso/src/lib/airline.ts b/packages/falso/src/lib/airline.ts
@@ -16,6 +16,10 @@ import { data } from './airline.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Aeroflot
+ * Air Canada
+ * Air Europa
  */
 
 export function randAirline<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/airport.ts b/packages/falso/src/lib/airport.ts
@@ -23,6 +23,10 @@ export interface Airport {
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * [object Object]
+ * [object Object]
+ * [object Object]
  */
 
 export function randAirport<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/alpha-numeric.ts b/packages/falso/src/lib/alpha-numeric.ts
@@ -18,6 +18,10 @@ import { randNumber } from './number';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * o
+ * e
+ * 9
  */
 
 export function randAlphaNumeric<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/alpha.ts b/packages/falso/src/lib/alpha.ts
@@ -16,6 +16,10 @@ import { alphaChars } from './sequence';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * g
+ * g
+ * l
  */
 
 export function randAlpha<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/american-football-team.ts b/packages/falso/src/lib/american-football-team.ts
@@ -16,6 +16,10 @@ import { data } from './american-football-team.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Arizona Cardinals
+ * Atlanta Falcons
+ * Baltimore Ravens
  */
 
 export function randAmericanFootballTeam<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/amount.ts b/packages/falso/src/lib/amount.ts
@@ -37,6 +37,10 @@ export interface RandomAmountOptions extends RandomInRangeOptions, FakeOptions {
  * randAmount({ length: 10 })
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * 8672.63
+ * 3284.82
+ * 9879.79
  */
 
 export function randAmount<

diff --git a/packages/falso/src/lib/animal-type.ts b/packages/falso/src/lib/animal-type.ts
@@ -16,6 +16,10 @@ import { data } from './animal-type.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * bird
+ * cetacean
+ * rabbit
  */
 
 export function randAnimalType<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/avatar.ts b/packages/falso/src/lib/avatar.ts
@@ -23,6 +23,10 @@ interface AvatarOptions extends FakeOptions {
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * https://i.pravatar.cc/100
+ * https://i.pravatar.cc/100
+ * https://i.pravatar.cc/100
  */
 
 export function randAvatar<Options extends AvatarOptions = never>(

diff --git a/packages/falso/src/lib/aws-region.ts b/packages/falso/src/lib/aws-region.ts
@@ -16,6 +16,10 @@ import { data } from './aws-region.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * us-east-2
+ * us-east-1
+ * us-west-1
  */
 
 export function randAwsRegion<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/aws-request-id.ts b/packages/falso/src/lib/aws-request-id.ts
@@ -16,6 +16,10 @@ import { fake, FakeOptions } from './core/core';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * 788k7v21-fa9h-0y1h-x6l8-rs8dpe1efc4y
+ * 5s3mlim3-737x-8ol6-d282-mg88umn271x5
+ * nm1dvo6p-uuj3-1l62-e131-lu249e634825
  */
 
 export function randAwsRequestId<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/aws-service.ts b/packages/falso/src/lib/aws-service.ts
@@ -16,6 +16,10 @@ import { data } from './aws-service.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * EC2
+ * RDS
+ * S3
  */
 
 export function randAwsService<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/baseball-team.ts b/packages/falso/src/lib/baseball-team.ts
@@ -16,6 +16,10 @@ import { data } from './baseball-team.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Arizona Diamondbacks
+ * Atlanta Braves
+ * Baltimore Orioles
  */
 
 export function randBaseballTeam<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/basketball-team.ts b/packages/falso/src/lib/basketball-team.ts
@@ -16,6 +16,10 @@ import { data } from './basketball-team.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Atlanta Hawks
+ * Boston Celtics
+ * Brooklyn Nets
  */
 
 export function randBasketballTeam<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/bear.ts b/packages/falso/src/lib/bear.ts
@@ -16,6 +16,10 @@ import { data } from './bear.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Spectacled bear
+ * Brown bear
+ * Asian black bear
  */
 
 export function randBear<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/binary.ts b/packages/falso/src/lib/binary.ts
@@ -15,6 +15,10 @@ import { FakeOptions, fake, getRandomInRange } from './core/core';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * 10010000100010100000011001101101000111010010001000100
+ * 1011010110110110110010000110110101111111101111011100
+ * 1000000100101111001100101001010111000001000000101010
  */
 
 export function randBinary<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/bitcoin-address.ts b/packages/falso/src/lib/bitcoin-address.ts
@@ -16,6 +16,10 @@ import { randSequence } from './sequence';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * BiBwVceNYUIzZiIM3iT5Pfa11H9eXIeBN
+ * 4LWPPHhYOB0OIJg8gMamYBCkVWCe96TBn
+ * RDdJ4ZMgtiT6KnSmAAncSlpgr2DlOMV8V
  */
 
 export function randBitcoinAddress<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/book.ts b/packages/falso/src/lib/book.ts
@@ -37,6 +37,10 @@ export interface Book {
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * [object Object]
+ * [object Object]
+ * [object Object]
  */
 
 export function randBook<Options extends BookOptions = never>(

diff --git a/packages/falso/src/lib/boolean.ts b/packages/falso/src/lib/boolean.ts
@@ -15,6 +15,10 @@ import { fake, FakeOptions, randElement } from './core/core';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * true
+ * false
+ * false
  */
 
 export function randBoolean<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/brand.ts b/packages/falso/src/lib/brand.ts
@@ -16,6 +16,10 @@ import { data } from './brand.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Apple
+ * Amazon
+ * Microsoft
  */
 
 export function randBrand<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/browser.ts b/packages/falso/src/lib/browser.ts
@@ -16,6 +16,10 @@ import { data } from './browser.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Chrome
+ * Edge
+ * Firefox
  */
 
 export function randBrowser<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/cardinal-direction.ts b/packages/falso/src/lib/cardinal-direction.ts
@@ -16,6 +16,10 @@ import { data } from './cardinal-direction.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * East
+ * South
+ * West
  */
 
 export function randCardinalDirection<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/cat.ts b/packages/falso/src/lib/cat.ts
@@ -16,6 +16,10 @@ import { data } from './cat.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Japanese Bobtail
+ * Savannah
+ * LaPerm
  */
 
 export function randCat<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/catch-phrase.ts b/packages/falso/src/lib/catch-phrase.ts
@@ -16,6 +16,10 @@ import { data } from './catch-phrase.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Persevering encompassing middleware
+ * Multi-layered zero administration system engine
+ * Digitized attitude-oriented implementation
  */
 
 export function randCatchPhrase<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/cetacean.ts b/packages/falso/src/lib/cetacean.ts
@@ -16,6 +16,10 @@ import { data } from './cetacean.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Clymene Dolphin
+ * Bottlenose Dolphin
+ * Costero
  */
 
 export function randCetacean<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/city.ts b/packages/falso/src/lib/city.ts
@@ -16,6 +16,10 @@ import { data } from './city.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * South Dagmarshire
+ * New Solonmouth
+ * New Montemouth
  */
 
 export function randCity<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/clothing-size.ts b/packages/falso/src/lib/clothing-size.ts
@@ -16,6 +16,10 @@ import { data } from './clothing-size.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * XXS
+ * XS
+ * S
  */
 
 export function randClothingSize<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/color.ts b/packages/falso/src/lib/color.ts
@@ -16,6 +16,10 @@ import { data } from './color.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * AliceBlue
+ * AntiqueWhite
+ * Aqua
  */
 
 export function randColor<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/company-name.ts b/packages/falso/src/lib/company-name.ts
@@ -16,6 +16,10 @@ import { data } from './company-name.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Kautzer, Macejkovic and Fisher
+ * Greenholt - Mosciski
+ * Marquardt - Runolfsdottir
  */
 
 export function randCompanyName<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/country-code.ts b/packages/falso/src/lib/country-code.ts
@@ -16,6 +16,10 @@ import { data } from './country-code.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * MS
+ * TW
+ * LR
  */
 
 export function randCountryCode<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/country.ts b/packages/falso/src/lib/country.ts
@@ -16,6 +16,10 @@ import { data } from './country.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Argentina
+ * Peru
+ * Colombia
  */
 
 export function randCountry<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/county.ts b/packages/falso/src/lib/county.ts
@@ -16,6 +16,10 @@ import { data } from './county.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Bedfordshire
+ * Berkshire
+ * Bristol
  */
 
 export function randCounty<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/cow.ts b/packages/falso/src/lib/cow.ts
@@ -16,6 +16,10 @@ import { data } from './cow.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * Hartón del Valle
+ * Pedit
+ * German Black Pied cattle
  */
 
 export function randCow<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/credit-card-brand.ts b/packages/falso/src/lib/credit-card-brand.ts
@@ -16,6 +16,10 @@ import { data } from './credit-card-brand.json';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * American Express
+ * T-Union
+ * UnionPay
  */
 
 export function randCreditCardBrand<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/credit-card-cvv.ts b/packages/falso/src/lib/credit-card-cvv.ts
@@ -15,6 +15,10 @@ import { fake, FakeOptions, getRandomInRange } from './core/core';
  *
  *
  * @automaticallyGeneratedExamples
+ * @example
+ * 721
+ * 584
+ * 106
  */
 
 export function randCreditCardCVV<Options extends FakeOptions = never>(