aboutsummaryrefslogtreecommitdiff
path: root/docs/guide/upgrading.md
blob: ac95b6b5f7733da7551a1a6264531b4fd3c95236 (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Upgrading to v7

This is the migration guide for upgrading from v6 to v7.

::: info
Not the version you are looking for?

- [v6.fakerjs.dev](https://v6.fakerjs.dev/migration-guide-v5/)

:::

## Node 12 no longer supported

You need at least Node 14 to use Faker.

## Default export removed

If you were previously importing faker like this:

```js
import faker from '@faker-js/faker';
```

You must instead use:

```js
import { faker } from '@faker-js/faker';
```

## Deprecated methods changed

Several methods were renamed or moved:

| Old method                 | New alternative                                        |
| -------------------------- | ------------------------------------------------------ |
| faker.random.number        | faker.datatype.number                                  |
| faker.random.float         | faker.datatype.float                                   |
| faker.random.arrayElement  | faker.helpers.arrayElement                             |
| faker.random.arrayElements | faker.helpers.arrayElements                            |
| faker.random.objectElement | faker.helpers.objectKey <br> faker.helpers.objectValue |
| faker.random.uuid          | faker.datatype.uuid                                    |
| faker.random.boolean       | faker.datatype.boolean                                 |
| faker.random.image         | faker.image.image                                      |
| faker.random.hexaDecimal   | faker.datatype.hexadecimal                             |
| faker.helpers.randomize    | faker.helpers.arrayElement                             |
| faker.datatype.hexaDecimal | faker.datatype.hexadecimal                             |
| faker.name.title           | faker.name.jobTitle                                    |

## Deprecated methods removed

Some methods were removed without a direct alternative. If you are using any of these methods you should build an object containing the specific properties you need.

| Removed method                  |
| ------------------------------- |
| faker.helpers.createCard        |
| faker.helpers.contextualCard    |
| faker.helpers.userCard          |
| faker.time                      |
| faker.helpers.createTransaction |