Skip to content

Readme link fixes #741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 21, 2021
Merged

Readme link fixes #741

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e9256b
Fixed repository mode links.
paul-mcnamee Feb 9, 2020
1c5d1e0
Use sequelize.org links since the github page link was broken.
paul-mcnamee Feb 9, 2020
a707919
Merge branch 'master' into readme-link-fixes
theoludwig Jan 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Decorators and some other features for sequelize (v6).
- [Indexes](#indexes)
- [`@Index` API](#index)
- [`createIndexDecorator()` API](#createindexdecorator)
- [Repository mode](#repository-mode)
- [Repository mode](#repository-mode-1)
- [How to enable repository mode?](#how-to-enable-repository-mode)
- [How to use repository mode?](#how-to-use-repository-mode)
- [How to use associations with repository mode?](#how-to-use-associations-with-repository-mode)
Expand Down Expand Up @@ -135,11 +135,11 @@ For `sequelize@4` & `sequelize@3` use `[email protected]`.

### Breaking Changes
All breaking changes of `sequelize@5` are also valid for `sequelize-typescript@1`.
See [Upgrade to v5](https://github.com/sequelize/sequelize/blob/master/docs/upgrade-to-v5.md) for details.
See [Upgrade to v5](https://sequelize.org/v5/manual/upgrade-to-v5.html) for details.

#### Official Sequelize Typings
sequelize-typescript now uses the official typings bundled with sequelize
(See [this](https://github.com/sequelize/sequelize/blob/master/docs/upgrade-to-v5.md#typescript-support)).
(See [this](https://sequelize.org/v5/manual/upgrade-to-v5.html#typescript-support)).
Please note the following details:
- Most of the sequelize-typescript interfaces of the previous version are replaced by the official ones
- `@types/sequelize` is no longer used
Expand All @@ -163,7 +163,7 @@ instead of deprecated way:
```

### Repository Mode
With `sequelize-typescript@1` comes a repository mode. See [docs](#repository-mode) for details.
With `sequelize-typescript@1` comes a repository mode. See [docs](#repository-mode-1) for details.


## Model definition
Expand Down Expand Up @@ -930,7 +930,7 @@ this issue.
## Recommendations and limitations

### One Sequelize instance per model (without repository mode)
Unless you are using the [repository mode](#repository-mode), you won't be able to add one and the same model to multiple
Unless you are using the [repository mode](#repository-mode-1), you won't be able to add one and the same model to multiple
Sequelize instances with differently configured connections. So that one model will only work for one connection.

### One model class per file
Expand Down