feat: 🔥 Tweak documentation comment to be priority specific

✅ Closes: #220
ngneat · May 12, 2022 · 641a875 · 641a875
1 parent e29cc7f
commit 641a875
Show file tree

Hide file tree

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

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

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

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

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

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

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

diff --git a/packages/falso/src/lib/airport.ts b/packages/falso/src/lib/airport.ts
@@ -23,7 +23,7 @@ export interface Airport {
  *
  * @example
  *
- * randAirport({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAirport({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +18,7 @@ import { randNumber } from './number';
  *
  * @example
  *
- * randAlphaNumeric({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAlphaNumeric({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randAlphaNumeric<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/alpha.ts b/packages/falso/src/lib/alpha.ts
@@ -16,7 +16,7 @@ import { alphaChars } from './sequence';
  *
  * @example
  *
- * randAlpha({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAlpha({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './american-football-team.json';
  *
  * @example
  *
- * randAmericanFootballTeam({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAmericanFootballTeam({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randAmericanFootballTeam<Options extends FakeOptions = never>(

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

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

diff --git a/packages/falso/src/lib/avatar.ts b/packages/falso/src/lib/avatar.ts
@@ -23,7 +23,7 @@ interface AvatarOptions extends FakeOptions {
  *
  * @example
  *
- * randAvatar({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAvatar({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './aws-region.json';
  *
  * @example
  *
- * randAwsRegion({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAwsRegion({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { fake, FakeOptions } from './core/core';
  *
  * @example
  *
- * randAwsRequestId({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAwsRequestId({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './aws-service.json';
  *
  * @example
  *
- * randAwsService({ length: 10, priority: 'unique' }) // default is 'length'
+ * randAwsService({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './baseball-team.json';
  *
  * @example
  *
- * randBaseballTeam({ length: 10, priority: 'unique' }) // default is 'length'
+ * randBaseballTeam({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './basketball-team.json';
  *
  * @example
  *
- * randBasketballTeam({ length: 10, priority: 'unique' }) // default is 'length'
+ * randBasketballTeam({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randBasketballTeam<Options extends FakeOptions = never>(

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

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

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

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

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

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

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

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

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

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

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

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

diff --git a/packages/falso/src/lib/code-snippet.ts b/packages/falso/src/lib/code-snippet.ts
@@ -42,7 +42,7 @@ interface CodeSnippetOptions extends FakeOptions {
  *
  * @example
  *
- * randCodeSnippet({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCodeSnippet({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randCodeSnippet<Options extends CodeSnippetOptions = never>(

diff --git a/packages/falso/src/lib/color.ts b/packages/falso/src/lib/color.ts
@@ -16,7 +16,7 @@ import { data } from './color.json';
  *
  * @example
  *
- * randColor({ length: 10, priority: 'unique' }) // default is 'length'
+ * randColor({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './company-name.json';
  *
  * @example
  *
- * randCompanyName({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCompanyName({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './country-code.json';
  *
  * @example
  *
- * randCountryCode({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCountryCode({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randCountryCode<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/country.ts b/packages/falso/src/lib/country.ts
@@ -16,7 +16,7 @@ import { data } from './country.json';
  *
  * @example
  *
- * randCountry({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCountry({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randCountry<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/county.ts b/packages/falso/src/lib/county.ts
@@ -16,7 +16,7 @@ import { data } from './county.json';
  *
  * @example
  *
- * randCounty({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCounty({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randCounty<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/cow.ts b/packages/falso/src/lib/cow.ts
@@ -16,7 +16,7 @@ import { data } from './cow.json';
  *
  * @example
  *
- * randCow({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCow({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +16,7 @@ import { data } from './credit-card-brand.json';
  *
  * @example
  *
- * randCreditCardBrand({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCreditCardBrand({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 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,7 +15,7 @@ import { fake, FakeOptions, getRandomInRange } from './core/core';
  *
  * @example
  *
- * randCreditCardCVV({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCreditCardCVV({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randCreditCardCVV<Options extends FakeOptions = never>(

diff --git a/packages/falso/src/lib/credit-card-number.ts b/packages/falso/src/lib/credit-card-number.ts
@@ -39,7 +39,7 @@ export type Brand =
  *
  * @example
  *
- * randCreditCardNumber({ length: 10, priority: 'unique' }) // default is 'length'
+ * randCreditCardNumber({ length: 10, priority: 'unique' }) // default priority is 'length'
  *
  */
 export function randCreditCardNumber<