Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: switch doc links to stable #2152

Merged
merged 5 commits into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Please proceed to the [Getting Started Guide](https://fakerjs.dev/guide/) for th

For detailed API documentation, please select the version of the documentation you are looking for.

| Version | Website |
| :---------: | :------------------------ |
| v8 (next) | https://next.fakerjs.dev/ |
| v7 (stable) | https://fakerjs.dev/ |
| v6 (old) | https://v6.fakerjs.dev/ |
| Version | Website |
| :----------: | :------------------------ |
| v8.\* (next) | https://next.fakerjs.dev/ |
| v8 (stable) | https://fakerjs.dev/ |
| v7 (old) | https://v7.fakerjs.dev/ |

Shinigami92 marked this conversation as resolved.
Show resolved Hide resolved
---

Expand Down Expand Up @@ -87,7 +87,7 @@ Thus, limiting the import to a single locale can speed up startup times.

## 💎 Modules

An in-depth overview of the API methods is available in the documentation for [v7 (stable)](https://fakerjs.dev/api/) and [v8 (next)](https://next.fakerjs.dev/api/).
An in-depth overview of the API methods is available in the documentation for [v8 (stable)](https://fakerjs.dev/api/) and [v8.\* (next)](https://next.fakerjs.dev/api/).

### Templates

Expand Down
14 changes: 7 additions & 7 deletions src/faker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export class Faker {
* The function must return a new valid `Date` instance for every call.
* Defaults to `() => new Date()`.
*
* @see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results)
* @see [Reproducible Results](https://fakerjs.dev/guide/usage.html#reproducible-results)
* @see faker.seed() for reproducible results.
*
* @example
Expand Down Expand Up @@ -180,7 +180,7 @@ export class Faker {
*
* You only need to use the constructor if you need custom fallback logic or a custom locale.
*
* For more information see our [Localization Guide](https://next.fakerjs.dev/guide/localization.html).
* For more information see our [Localization Guide](https://fakerjs.dev/guide/localization.html).
*
* @param options The options to use.
* @param options.locale The locale data to use.
Expand Down Expand Up @@ -213,7 +213,7 @@ export class Faker {
*
* You only need to use the constructor if you need custom fallback logic or a custom locale.
*
* For more information see our [Localization Guide](https://next.fakerjs.dev/guide/localization.html).
* For more information see our [Localization Guide](https://fakerjs.dev/guide/localization.html).
*
* @param options The options to use.
* @param options.locales The locale data to use.
Expand All @@ -235,7 +235,7 @@ export class Faker {
*
* You only need to use the constructor if you need custom fallback logic or a custom locale.
*
* For more information see our [Localization Guide](https://next.fakerjs.dev/guide/localization.html).
* For more information see our [Localization Guide](https://fakerjs.dev/guide/localization.html).
*
* @param options The options to use.
* @param options.locale The locale data to use or the name of the main locale.
Expand Down Expand Up @@ -353,7 +353,7 @@ export class Faker {
*
* @returns The seed that was set.
*
* @see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results)
* @see [Reproducible Results](https://fakerjs.dev/guide/usage.html#reproducible-results)
* @see faker.setDefaultRefDate() when generating relative dates.
*
* @example
Expand Down Expand Up @@ -388,7 +388,7 @@ export class Faker {
*
* @returns The seed array that was set.
*
* @see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results)
* @see [Reproducible Results](https://fakerjs.dev/guide/usage.html#reproducible-results)
* @see faker.setDefaultRefDate() when generating relative dates.
*
* @example
Expand Down Expand Up @@ -423,7 +423,7 @@ export class Faker {
*
* @returns The seed that was set.
*
* @see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results)
* @see [Reproducible Results](https://fakerjs.dev/guide/usage.html#reproducible-results)
* @see faker.setDefaultRefDate() when generating relative dates.
*
* @example
Expand Down
2 changes: 1 addition & 1 deletion src/locale-proxy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ function createCategoryProxy<
throw new FakerError(
`The locale data for '${categoryName}.${entryName.toString()}' are missing in this locale.
Please contribute the missing data to the project or use a locale/Faker instance that has these data.
For more information see https://next.fakerjs.dev/guide/localization.html`
For more information see https://fakerjs.dev/guide/localization.html`
);
} else {
return value;
Expand Down
8 changes: 4 additions & 4 deletions src/modules/airline/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ const aircraftTypeSeats: Record<AircraftType, string[]> = {
*
* Several methods in this module return objects rather than strings. For example, you can use `faker.airline.airport().iataCode` to pick out the specific property you need.
*
* For a random airport, use [`airport()`](https://next.fakerjs.dev/api/airline.html#airport).
* For a random airport, use [`airport()`](https://fakerjs.dev/api/airline.html#airport).
*
* For a random airline, use [`airline()`](https://next.fakerjs.dev/api/airline.html#airline).
* For a random airline, use [`airline()`](https://fakerjs.dev/api/airline.html#airline).
*
* For a dummy booking, a passenger will generally book a flight on a specific [`flightNumber()`](https://next.fakerjs.dev/api/airline.html#flightnumber), [`airplane()`](https://next.fakerjs.dev/api/airline.html#airplane), be allocated a [`seat()`](https://next.fakerjs.dev/api/airline.html#seat), and [`recordLocator()`](https://next.fakerjs.dev/api/airline.html#recordlocator).
* For a dummy booking, a passenger will generally book a flight on a specific [`flightNumber()`](https://fakerjs.dev/api/airline.html#flightnumber), [`airplane()`](https://fakerjs.dev/api/airline.html#airplane), be allocated a [`seat()`](https://fakerjs.dev/api/airline.html#seat), and [`recordLocator()`](https://fakerjs.dev/api/airline.html#recordlocator).
*
* ### Related Modules
*
* - To generate sample passenger data, you can use the methods of the [`faker.person`](https://next.fakerjs.dev/api/person.html) module.
* - To generate sample passenger data, you can use the methods of the [`faker.person`](https://fakerjs.dev/api/person.html) module.
*/
export class AirlineModule {
constructor(private readonly faker: Faker) {
Expand Down
4 changes: 2 additions & 2 deletions src/modules/animal/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import type { Faker } from '../..';
*
* ### Overview
*
* For a general type of animal (e.g. `'dog'`), use [`type()`](https://next.fakerjs.dev/api/animal.html#type).
* For a general type of animal (e.g. `'dog'`), use [`type()`](https://fakerjs.dev/api/animal.html#type).
*
* Otherwise, use one of the more specific methods, such as [`cat()`](https://next.fakerjs.dev/api/animal.html#cat) for a specific breed of cat.
* Otherwise, use one of the more specific methods, such as [`cat()`](https://fakerjs.dev/api/animal.html#cat) for a specific breed of cat.
*
* All values may be localized.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/modules/color/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,9 @@ function toColorFormat(
*
* ### Overview
*
* For a human-readable color like `'red'`, use [`human()`](https://next.fakerjs.dev/api/color.html#human).
* For a human-readable color like `'red'`, use [`human()`](https://fakerjs.dev/api/color.html#human).
*
* For a hex color like `#ff0000` used in HTML/CSS, use [`rgb()`](https://next.fakerjs.dev/api/color.html#rgb). There are also methods for other color formats such as [`hsl()`](https://next.fakerjs.dev/api/color.html#hsl), [`cmyk()`](https://next.fakerjs.dev/api/color.html#cmyk), [`hwb()`](https://next.fakerjs.dev/api/color.html#hwb), [`lab()`](https://next.fakerjs.dev/api/color.html#lab), and [`lch()`](https://next.fakerjs.dev/api/color.html#lch).
* For a hex color like `#ff0000` used in HTML/CSS, use [`rgb()`](https://fakerjs.dev/api/color.html#rgb). There are also methods for other color formats such as [`hsl()`](https://fakerjs.dev/api/color.html#hsl), [`cmyk()`](https://fakerjs.dev/api/color.html#cmyk), [`hwb()`](https://fakerjs.dev/api/color.html#hwb), [`lab()`](https://fakerjs.dev/api/color.html#lab), and [`lch()`](https://fakerjs.dev/api/color.html#lch).
*/
export class ColorModule {
constructor(private readonly faker: Faker) {
Expand Down
6 changes: 3 additions & 3 deletions src/modules/commerce/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import { deprecated } from '../../internal/deprecated';
*
* ### Overview
*
* For a long product name like `'Incredible Soft Gloves'`, use [`productName()`](https://next.fakerjs.dev/api/commerce.html#productname). The product names are generated from a list of adjectives, materials, and products, which can each be accessed separately using [`productAdjective()`](https://next.fakerjs.dev/api/commerce.html#productadjective), [`productMaterial()`](https://next.fakerjs.dev/api/commerce.html#productmaterial), and [`product()`](https://next.fakerjs.dev/api/commerce.html#product). You can also create a description using [`productDescription()`](https://next.fakerjs.dev/api/commerce.html#productdescription).
* For a long product name like `'Incredible Soft Gloves'`, use [`productName()`](https://fakerjs.dev/api/commerce.html#productname). The product names are generated from a list of adjectives, materials, and products, which can each be accessed separately using [`productAdjective()`](https://fakerjs.dev/api/commerce.html#productadjective), [`productMaterial()`](https://fakerjs.dev/api/commerce.html#productmaterial), and [`product()`](https://fakerjs.dev/api/commerce.html#product). You can also create a description using [`productDescription()`](https://fakerjs.dev/api/commerce.html#productdescription).
*
* For a department in a shop or product category, use [`department()`](https://next.fakerjs.dev/api/commerce.html#department).
* For a department in a shop or product category, use [`department()`](https://fakerjs.dev/api/commerce.html#department).
*
* You can also create a price using [`price()`](https://next.fakerjs.dev/api/commerce.html#price).
* You can also create a price using [`price()`](https://fakerjs.dev/api/commerce.html#price).
*/
export class CommerceModule {
constructor(private readonly faker: Faker) {
Expand Down
8 changes: 4 additions & 4 deletions src/modules/company/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ import { deprecated } from '../../internal/deprecated';
*
* ### Overview
*
* To generate a random company name, use [`name()`](https://next.fakerjs.dev/api/company.html#name). This is localized in many locales.
* To generate a random company name, use [`name()`](https://fakerjs.dev/api/company.html#name). This is localized in many locales.
*
* To generate jargon-filled company catchphrases and buzzwords, use [`catchPhrase()`](https://next.fakerjs.dev/api/company.html#catchphrase) or [`buzzPhrase()`](https://next.fakerjs.dev/api/company.html#buzzphrase).
* To generate jargon-filled company catchphrases and buzzwords, use [`catchPhrase()`](https://fakerjs.dev/api/company.html#catchphrase) or [`buzzPhrase()`](https://fakerjs.dev/api/company.html#buzzphrase).
*
* ### Related Modules
*
* - For products and commerce, use [`faker.commerce`](https://next.fakerjs.dev/api/commerce.html).
* - For finance-related entries, use [`faker.finance`](https://next.fakerjs.dev/api/finance.html).
* - For products and commerce, use [`faker.commerce`](https://fakerjs.dev/api/commerce.html).
* - For finance-related entries, use [`faker.finance`](https://fakerjs.dev/api/finance.html).
*/
export class CompanyModule {
constructor(private readonly faker: Faker) {
Expand Down
4 changes: 2 additions & 2 deletions src/modules/database/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import type { Faker } from '../..';
*
* ### Overview
*
* Traditional relational database tables have data organized in columns with specific types - [`column()`](https://next.fakerjs.dev/api/database.html#column), [`type()`](https://next.fakerjs.dev/api/database.html#type). The database usually has an [`engine()`](https://next.fakerjs.dev/api/database.html#engine) and a default [`collation()`](https://next.fakerjs.dev/api/database.html#collation) for sorting.
* Traditional relational database tables have data organized in columns with specific types - [`column()`](https://fakerjs.dev/api/database.html#column), [`type()`](https://fakerjs.dev/api/database.html#type). The database usually has an [`engine()`](https://fakerjs.dev/api/database.html#engine) and a default [`collation()`](https://fakerjs.dev/api/database.html#collation) for sorting.
*
* For the NoSQL database MongoDB, [`mongodbObjectId()`](https://next.fakerjs.dev/api/database.html#mongodbobjectid) provides a random ID.
* For the NoSQL database MongoDB, [`mongodbObjectId()`](https://fakerjs.dev/api/database.html#mongodbobjectid) provides a random ID.
*/
export class DatabaseModule {
constructor(private readonly faker: Faker) {
Expand Down
4 changes: 2 additions & 2 deletions src/modules/datatype/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import { deprecated } from '../../internal/deprecated';
*
* ### Overview
*
* Most of the methods in this module are deprecated and have been moved to other modules like [`faker.number`](https://next.fakerjs.dev/api/number.html) and [`faker.string`](https://next.fakerjs.dev/api/string.html), see individual entries for replacements.
* Most of the methods in this module are deprecated and have been moved to other modules like [`faker.number`](https://fakerjs.dev/api/number.html) and [`faker.string`](https://fakerjs.dev/api/string.html), see individual entries for replacements.
*
* For a simple random true or false value, use [`boolean()`](https://next.fakerjs.dev/api/datatype.html#boolean).
* For a simple random true or false value, use [`boolean()`](https://fakerjs.dev/api/datatype.html#boolean).
*/
export class DatatypeModule {
constructor(private readonly faker: Faker) {
Expand Down
12 changes: 6 additions & 6 deletions src/modules/date/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ function toDate(
*
* ### Overview
*
* To quickly generate a date in the past, use [`recent()`](https://next.fakerjs.dev/api/date.html#recent) (last day) or [`past()`](https://next.fakerjs.dev/api/date.html#past) (last year).
* To quickly generate a date in the future, use [`soon()`](https://next.fakerjs.dev/api/date.html#soon) (next day) or [`future()`](https://next.fakerjs.dev/api/date.html#future) (next year).
* For a realistic birthdate for an adult, use [`birthdate()`](https://next.fakerjs.dev/api/date.html#birthdate).
* To quickly generate a date in the past, use [`recent()`](https://fakerjs.dev/api/date.html#recent) (last day) or [`past()`](https://fakerjs.dev/api/date.html#past) (last year).
* To quickly generate a date in the future, use [`soon()`](https://fakerjs.dev/api/date.html#soon) (next day) or [`future()`](https://fakerjs.dev/api/date.html#future) (next year).
* For a realistic birthdate for an adult, use [`birthdate()`](https://fakerjs.dev/api/date.html#birthdate).
*
* For more control, any of these methods can be customized with further options, or use [`between()`](https://next.fakerjs.dev/api/date.html#between) to generate a single date between two dates, or [`betweens()`](https://next.fakerjs.dev/api/date.html#betweens) for multiple dates.
* For more control, any of these methods can be customized with further options, or use [`between()`](https://fakerjs.dev/api/date.html#between) to generate a single date between two dates, or [`betweens()`](https://fakerjs.dev/api/date.html#betweens) for multiple dates.
*
* You can generate random localized month and weekday names using [`month()`](https://next.fakerjs.dev/api/date.html#month) and [`weekday()`](https://next.fakerjs.dev/api/date.html#weekday).
* You can generate random localized month and weekday names using [`month()`](https://fakerjs.dev/api/date.html#month) and [`weekday()`](https://fakerjs.dev/api/date.html#weekday).
*
* These methods have additional concerns about reproducibility, see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results).
* These methods have additional concerns about reproducibility, see [Reproducible Results](https://fakerjs.dev/guide/usage.html#reproducible-results).
*/
export class DateModule {
constructor(private readonly faker: Faker) {
Expand Down
8 changes: 4 additions & 4 deletions src/modules/finance/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ export interface Currency {
*
* ### Overview
*
* For a random amount, use [`amount()`](https://next.fakerjs.dev/api/finance.html#amount).
* For a random amount, use [`amount()`](https://fakerjs.dev/api/finance.html#amount).
*
* For traditional bank accounts, use: [`accountNumber()`](https://next.fakerjs.dev/api/finance.html#accountnumber), [`accountName()`](https://next.fakerjs.dev/api/finance.html#accountname), [`bic()`](https://next.fakerjs.dev/api/finance.html#bic), [`iban()`](https://next.fakerjs.dev/api/finance.html#iban), [`pin()`](https://next.fakerjs.dev/api/finance.html#pin) and [`routingNumber()`](https://next.fakerjs.dev/api/finance.html#routingnumber).
* For traditional bank accounts, use: [`accountNumber()`](https://fakerjs.dev/api/finance.html#accountnumber), [`accountName()`](https://fakerjs.dev/api/finance.html#accountname), [`bic()`](https://fakerjs.dev/api/finance.html#bic), [`iban()`](https://fakerjs.dev/api/finance.html#iban), [`pin()`](https://fakerjs.dev/api/finance.html#pin) and [`routingNumber()`](https://fakerjs.dev/api/finance.html#routingnumber).
*
* For credit card related methods, use: [`creditCardNumber()`](https://next.fakerjs.dev/api/finance.html#creditcardnumber), [`creditCardCVV()`](https://next.fakerjs.dev/api/finance.html#creditcardcvv), [`creditCardIssuer()`](https://next.fakerjs.dev/api/finance.html#creditcardissuer), [`transactionDescription()`](https://next.fakerjs.dev/api/finance.html#transactiondescription) and [`transactionType()`](https://next.fakerjs.dev/api/finance.html#transactiontype).
Shinigami92 marked this conversation as resolved.
Show resolved Hide resolved
* For credit card related methods, use: [`creditCardNumber()`](https://fakerjs.dev/api/finance.html#creditcardnumber), [`creditCardCVV()`](https://fakerjs.dev/api/finance.html#creditcardcvv), [`creditCardIssuer()`](https://fakerjs.dev/api/finance.html#creditcardissuer), [`transactionDescription()`](https://fakerjs.dev/api/finance.html#transactiondescription) and [`transactionType()`](https://fakerjs.dev/api/finance.html#transactiontype).
*
* For blockchain related methods, use: [`bitcoinAddress()`](https://next.fakerjs.dev/api/finance.html#bitcoinaddress), [`ethereumAddress()`](https://next.fakerjs.dev/api/finance.html#ethereumaddress) and [`litecoinAddress()`](https://next.fakerjs.dev/api/finance.html#litecoinaddress).
* For blockchain related methods, use: [`bitcoinAddress()`](https://fakerjs.dev/api/finance.html#bitcoinaddress), [`ethereumAddress()`](https://fakerjs.dev/api/finance.html#ethereumaddress) and [`litecoinAddress()`](https://fakerjs.dev/api/finance.html#litecoinaddress).
*/
export class FinanceModule {
constructor(private readonly faker: Faker) {
Expand Down
2 changes: 1 addition & 1 deletion src/modules/git/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const GIT_TIMEZONE_FORMAT = new Intl.NumberFormat('en', {
*
* ### Overview
*
* [`commitEntry()`](https://next.fakerjs.dev/api/git.html#commitentry) generates a random commit entry as printed by `git log`. This includes a commit hash [`commitSha()`](https://next.fakerjs.dev/api/git.html#commitsha), author, date [`commitDate()`](https://next.fakerjs.dev/api/git.html#commitdate), and commit message [`commitMessage()`](https://next.fakerjs.dev/api/git.html#commitmessage). You can also generate a random branch name with [`branch()`](https://next.fakerjs.dev/api/git.html#branch).
* [`commitEntry()`](https://fakerjs.dev/api/git.html#commitentry) generates a random commit entry as printed by `git log`. This includes a commit hash [`commitSha()`](https://fakerjs.dev/api/git.html#commitsha), author, date [`commitDate()`](https://fakerjs.dev/api/git.html#commitdate), and commit message [`commitMessage()`](https://fakerjs.dev/api/git.html#commitmessage). You can also generate a random branch name with [`branch()`](https://fakerjs.dev/api/git.html#branch).
*/
export class GitModule {
constructor(private readonly faker: Faker) {
Expand Down
Loading