Skip to content

Commit

Permalink
Updated README with API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
theianjohnson committed Nov 11, 2023
1 parent 7a51673 commit f1afa91
Showing 1 changed file with 0 additions and 6 deletions.
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,6 @@ yarn add expo-sqlite-eloquent-orm
| `belongsTo` | Defines a belongs-to relationship. | `Promise<Model \| null>` | `relatedModel: Model, foreignKey: string, otherKey: string = 'id'` |
| `belongsToMany` | Defines a belongs-to-many relationship. | `Promise<Model[]>` | `relatedModel: typeof Model, joinTableName?: string, foreignKey?: string, otherKey?: string` |

### Utility Methods

| Method | Description | Return Type | Parameters |
| ------ | ----------- | ----------- | ---------- |
| `cleanObject` | Cleans the instance by applying casts and removing clauses. | `T` | `object: T` |

### Types and Interfaces

- `Casts`: Record of attribute types (`'number' \| 'boolean' \| 'string' \| 'json'`).
Expand Down

0 comments on commit f1afa91

Please sign in to comment.