aboutsummaryrefslogtreecommitdiff
path: root/src/definitions/phone_number.ts
blob: fd6a8baa47eee3f80edbb5a7d961e8e0223d28cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import type { LocaleEntry } from './definitions';

/**
 * The possible definitions related to phone numbers.
 */
export type PhoneNumberDefinition = LocaleEntry<{
  /**
   * Some patterns used to generate phone numbers.
   * `#` will be replaced by a random digit (0-9).
   * `!` will be replaced by a random digit (2-9).
   * (e.g. `!##-!##-####` -> 272-285-0453)
   *
   * @see faker.helpers.replaceSymbolWithNumber(format)
   */
  formats: string[];
}>;