Skip to content

Commit 8ef4dbd

Browse files
authored
fix 'entity' and 'entities' typo
1 parent 341f5e8 commit 8ef4dbd

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ Isn't it exhausting to create some sample data for your database, well this time
4141

4242
How does it work? Just create a entity factory for your entities (models) and a seed script.
4343

44-
### Enity
44+
### Entity
4545

46-
First create your TypeORM entites.
46+
First create your TypeORM entities.
4747

4848
```typescript
4949
// user.entity.ts
@@ -140,7 +140,7 @@ npm install -D @types/faker
140140

141141
### Configuration
142142

143-
To configure the path to your seeds and factories change the TypeORM config file(ormconfig.js or ormconfig.json).
143+
To configure the path to your seeds and factories change the TypeORM config file (ormconfig.js or ormconfig.json).
144144

145145
> The default paths are `src/database/{seeds,factories}/**/*{.ts,.js}`
146146
@@ -231,13 +231,13 @@ For all entities we want to create, we need to define a factory. To do so we giv
231231

232232
| Types | Description |
233233
| --------------- | ------------------------------------------------------------------------------- |
234-
| `Enity` | TypeORM Enity like the user or the pet in the samples. |
234+
| `Entity` | TypeORM Entity like the user or the pet in the samples. |
235235
| `Context` | Argument to pass some static data into the factory function. |
236236
| `EntityFactory` | This object is used to make new filled entities or create it into the database. |
237237

238238
### `define`
239239

240-
The define function creates a new enity factory.
240+
The define function creates a new entity factory.
241241

242242
```typescript
243243
define: <Entity, Context>(entity: Entity, factoryFn: FactoryFunction<Entity, Context>) => void;
@@ -286,9 +286,9 @@ await factory(User)()
286286

287287
#### `make` & `makeMany`
288288

289-
Make and makeMany executes the factory functions and return a new instance of the given enity. The instance is filled with the generated values from the factory function, but not saved in the database.
289+
Make and makeMany executes the factory functions and return a new instance of the given entity. The instance is filled with the generated values from the factory function, but not saved in the database.
290290

291-
**overrideParams** - Override some of the attributes of the enity.
291+
**overrideParams** - Override some of the attributes of the entity.
292292

293293
```typescript
294294
make(overrideParams: EntityProperty<Entity> = {}): Promise<Entity>
@@ -307,7 +307,7 @@ await factory(User)().makeMany(10, { email: 'other@mail.com' })
307307

308308
the create and createMany method is similar to the make and makeMany method, but at the end the created entity instance gets persisted in the database.
309309

310-
**overrideParams** - Override some of the attributes of the enity.
310+
**overrideParams** - Override some of the attributes of the entity.
311311

312312
```typescript
313313
create(overrideParams: EntityProperty<Entity> = {}): Promise<Entity>

0 commit comments

Comments
 (0)