aboutsummaryrefslogtreecommitdiff
path: root/src/definitions/finance.ts
blob: 89fc51ea2786cc4a5951878daaa9b6ff0b450a8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
import type { LocaleEntry } from './definitions';

/**
 * The possible definitions related to finance.
 */
export type FinanceDefinitions = LocaleEntry<{
  /**
   * The types of accounts/purposes of an account (e.g. `Savings` account).
   */
  account_type: string[];

  /**
   * The pattern by (lowercase) issuer name used to generate credit card codes.
   * `L` will be replaced by the check bit.
   *
   * @see faker.helpers.replaceCreditCardSymbols()
   */
  credit_card: { [issuer: string]: string[] };

  /**
   * Currencies by their full name and their symbols (e.g. `US Dollar` -> `USD` / `$`).
   */
  currency: { [currencyName: string]: FinanceCurrencyEntryDefinitions };

  /**
   * Types of transactions (e.g. `deposit`).
   */
  transaction_type: string[];
}>;

/**
 * The possible definitions related to currency entries.
 */
export interface FinanceCurrencyEntryDefinitions {
  /**
   * The code/short text/abbreviation for the currency (e.g. `USD`).
   */
  code: string;

  /**
   * The symbol for the currency (e.g. `$`).
   */
  symbol: string;
}