feat: 🔥 Add missing priority doc comment

Add missing priority doc comment ✅ Closes: #220
ngneat · Apr 5, 2022 · d57bd25 · d57bd25
1 parent ff6980a
commit d57bd25
Show file tree

Hide file tree

Showing 192 changed files with 796 additions and 33 deletions.
diff --git a/packages/falso/src/lib/abbreviation.ts b/packages/falso/src/lib/abbreviation.ts
@@ -14,6 +14,10 @@ import { data } from './abbreviation.json';
  *
  * randAbbreviation({ length: 10 })
  *
+ * @example
+ *
+ * randAbbreviation({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAbbreviation<O extends FakeOptions = never>(options?: O) {
   return fake(data, options);

diff --git a/packages/falso/src/lib/accessory.ts b/packages/falso/src/lib/accessory.ts
@@ -14,6 +14,10 @@ import { data } from './accessory.json';
  *
  * randAccessory({ length: 10 })
  *
+ * @example
+ *
+ * randAccessory({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAccessory<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/account.ts b/packages/falso/src/lib/account.ts
@@ -21,6 +21,10 @@ export interface AccountOptions extends FakeOptions {
  *
  * randAccount({ length: 10 })
  *
+ * @example
+ *
+ * randAccount({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAccount<Options extends AccountOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/address.ts b/packages/falso/src/lib/address.ts
@@ -39,6 +39,10 @@ export interface Address {
  *
  * randAddress({ length: 10 })
  *
+ * @example
+ *
+ * randAddress({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAddress<Options extends AddressOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/airline.ts b/packages/falso/src/lib/airline.ts
@@ -14,6 +14,10 @@ import { data } from './airline.json';
  *
  * randAirline({ length: 10 })
  *
+ * @example
+ *
+ * randAirline({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAirline<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/airport-code.ts b/packages/falso/src/lib/airport-code.ts
@@ -15,6 +15,10 @@ import { rand } from './rand';
  *
  * randAirportCode({ length: 10 })
  *
+ * @example
+ *
+ * randAirportCode({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAirportCode<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/airport-name.ts b/packages/falso/src/lib/airport-name.ts
@@ -15,6 +15,10 @@ import { rand } from './rand';
  *
  * randAirportName({ length: 10 })
  *
+ * @example
+ *
+ * randAirportName({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAirportName<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/airport.ts b/packages/falso/src/lib/airport.ts
@@ -21,6 +21,10 @@ export interface Airport {
  *
  * randAirport({ length: 10 })
  *
+ * @example
+ *
+ * randAirport({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAirport<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/alpha-numeric.ts b/packages/falso/src/lib/alpha-numeric.ts
@@ -16,6 +16,10 @@ import { randNumber } from './number';
  *
  * randAlphaNumeric({ length: 3 })
  *
+ * @example
+ *
+ * randAlphaNumeric({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAlphaNumeric<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/alpha.ts b/packages/falso/src/lib/alpha.ts
@@ -14,6 +14,10 @@ import { alphaChars } from './sequence';
  *
  * randAlpha({ length: 3 })
  *
+ * @example
+ *
+ * randAlpha({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAlpha<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/american-football-team.ts b/packages/falso/src/lib/american-football-team.ts
@@ -14,6 +14,10 @@ import { data } from './american-football-team.json';
  *
  * randAmericanFootballTeam({ length: 10 })
  *
+ * @example
+ *
+ * randAmericanFootballTeam({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAmericanFootballTeam<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/animal-type.ts b/packages/falso/src/lib/animal-type.ts
@@ -14,6 +14,10 @@ import { data } from './animal-type.json';
  *
  * randAnimalType({ length: 10 })
  *
+ * @example
+ *
+ * randAnimalType({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAnimalType<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/arn.ts b/packages/falso/src/lib/arn.ts
@@ -35,6 +35,10 @@ const serviceArn: Record<string, () => string> = {
  *
  * randArn({ length: 10 })
  *
+ * @example
+ *
+ * randArn({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randArn<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/avatar.ts b/packages/falso/src/lib/avatar.ts
@@ -15,11 +15,15 @@ interface AvatarOptions extends FakeOptions {
  *
  * @example
  *
+ * randAvatar({ size: 200 }) // default is 100
+ *
+ * @example
+ *
  * randAvatar({ length: 10 })
  *
  * @example
  *
- * randAvatar({ size: 200 }) // default is 100
+ * randAvatar({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
  *
  */
 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
@@ -14,6 +14,10 @@ import { data } from './aws-region.json';
  *
  * randAwsRegion({ length: 10 })
  *
+ * @example
+ *
+ * randAwsRegion({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAwsRegion<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/aws-request-id.ts b/packages/falso/src/lib/aws-request-id.ts
@@ -14,6 +14,10 @@ import { fake, FakeOptions } from './core/core';
  *
  * randAwsRequestId({ length: 10 })
  *
+ * @example
+ *
+ * randAwsRequestId({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAwsRequestId<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/aws-service.ts b/packages/falso/src/lib/aws-service.ts
@@ -14,6 +14,10 @@ import { data } from './aws-service.json';
  *
  * randAwsService({ length: 10 })
  *
+ * @example
+ *
+ * randAwsService({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randAwsService<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/baseball-team.ts b/packages/falso/src/lib/baseball-team.ts
@@ -14,6 +14,10 @@ import { data } from './baseball-team.json';
  *
  * randBaseballTeam({ length: 10 })
  *
+ * @example
+ *
+ * randBaseballTeam({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBaseballTeam<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/basketball-team.ts b/packages/falso/src/lib/basketball-team.ts
@@ -14,6 +14,10 @@ import { data } from './basketball-team.json';
  *
  * randBasketballTeam({ length: 10 })
  *
+ * @example
+ *
+ * randBasketballTeam({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBasketballTeam<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/bear.ts b/packages/falso/src/lib/bear.ts
@@ -14,6 +14,10 @@ import { data } from './bear.json';
  *
  * randBear({ length: 10 })
  *
+ * @example
+ *
+ * randBear({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBear<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/between-date.ts b/packages/falso/src/lib/between-date.ts
@@ -19,6 +19,10 @@ interface BetweenOptions extends FakeOptions {
  *
  * randBetweenDate({ from: new Date('10/07/2020'), to: new Date(), length: 10 })
  *
+ * @example
+ *
+ * randBetweenDate({ from: new Date('10/07/2020'), to: new Date(), length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBetweenDate<Options extends BetweenOptions = never>(
   options: Options

diff --git a/packages/falso/src/lib/binary.ts b/packages/falso/src/lib/binary.ts
@@ -13,6 +13,10 @@ import { FakeOptions, fake, getRandomInRange } from './core/core';
  *
  * randBinary({ length: 10 })
  *
+ * @example
+ *
+ * randBinary({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBinary<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/bird.ts b/packages/falso/src/lib/bird.ts
@@ -14,6 +14,10 @@ import { data } from './bird.i18n.json';
  *
  * randBird({ length: 10 })
  *
+ * @example
+ *
+ * randBird({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBird<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/bitcoin-address.ts b/packages/falso/src/lib/bitcoin-address.ts
@@ -14,6 +14,10 @@ import { randSequence } from './sequence';
  *
  * randBitcoinAddress({ length: 10 })
  *
+ * @example
+ *
+ * randBitcoinAddress({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBitcoinAddress<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/book.ts b/packages/falso/src/lib/book.ts
@@ -29,11 +29,15 @@ export interface Book {
  *
  * @example
  *
+ * randBook({ category: 'Comedy' })
+ *
+ * @example
+ *
  * randBook({ length: 10 })
  *
  * @example
  *
- * randBook({ category: 'Comedy' })
+ * randBook({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
  *
  */
 export function randBook<Options extends BookOptions = never>(

diff --git a/packages/falso/src/lib/boolean.ts b/packages/falso/src/lib/boolean.ts
@@ -13,6 +13,10 @@ import { fake, FakeOptions, randElement } from './core/core';
  *
  * randBoolean({ length: 10 })
  *
+ * @example
+ *
+ * randBoolean({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBoolean<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/brand.ts b/packages/falso/src/lib/brand.ts
@@ -14,6 +14,10 @@ import { data } from './brand.json';
  *
  * randBrand({ length: 10 })
  *
+ * @example
+ *
+ * randBrand({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBrand<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/browser.ts b/packages/falso/src/lib/browser.ts
@@ -14,6 +14,10 @@ import { data } from './browser.json';
  *
  * randBrowser({ length: 10 })
  *
+ * @example
+ *
+ * randBrowser({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randBrowser<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/cardinal-direction.ts b/packages/falso/src/lib/cardinal-direction.ts
@@ -14,6 +14,10 @@ import { data } from './cardinal-direction.json';
  *
  * randCardinalDirection({ length: 10 })
  *
+ * @example
+ *
+ * randCardinalDirection({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randCardinalDirection<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/cat.ts b/packages/falso/src/lib/cat.ts
@@ -14,6 +14,10 @@ import { data } from './cat.json';
  *
  * randCat({ length: 10 })
  *
+ * @example
+ *
+ * randCat({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randCat<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/catch-phrase.ts b/packages/falso/src/lib/catch-phrase.ts
@@ -14,6 +14,10 @@ import { data } from './catch-phrase.json';
  *
  * randCatchPhrase({ length: 10 })
  *
+ * @example
+ *
+ * randCatchPhrase({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randCatchPhrase<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/cetacean.ts b/packages/falso/src/lib/cetacean.ts
@@ -14,6 +14,10 @@ import { data } from './cetacean.json';
  *
  * randCetacean({ length: 10 })
  *
+ * @example
+ *
+ * randCetacean({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randCetacean<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/city.ts b/packages/falso/src/lib/city.ts
@@ -14,6 +14,10 @@ import { data } from './city.json';
  *
  * randCity({ length: 10 })
  *
+ * @example
+ *
+ * randCity({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randCity<Options extends FakeOptions = never>(
   options?: Options

diff --git a/packages/falso/src/lib/clothing-size.ts b/packages/falso/src/lib/clothing-size.ts
@@ -14,6 +14,10 @@ import { data } from './clothing-size.json';
  *
  * randClothingSize({ length: 10 })
  *
+ * @example
+ *
+ * randClothingSize({ length: 10, priority: 'unique' }) // default is 'length' ('length' | 'unique')
+ *
  */
 export function randClothingSize<Options extends FakeOptions = never>(
   options?: Options