Skip to content

Commit da83a61

Browse files
Updates dependencies; Adds new mocha config
2 parents 3afde3a + e3bb171 commit da83a61

15 files changed

+2301
-1803
lines changed

Diff for: .gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,8 @@ npm-debug.log
2727
coverage
2828
.nyc_output
2929
!test/tsconfig.mocha.js
30+
!.mocharc.js
31+
32+
33+
# lockFile
34+
*.lock

Diff for: .mocharc.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/**
2+
* @type {MochaSetupOptions}
3+
*/
4+
module.exports = {
5+
extension: ['ts'],
6+
require: [
7+
'test/tsconfig.mocha.js'
8+
],
9+
package: './package.json',
10+
'watch-files': ['test/**/*.spec.ts'],
11+
// 'watch-ignore': ['lib/vendor']
12+
};

Diff for: README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Decorators and some other features for sequelize (v5).
3737
- [Recommendations and limitations](#recommendations-and-limitations)
3838

3939
## Installation
40-
*sequelize-typescript* requires [sequelize](https://github.com/sequelize/sequelize), additional typings as documented [here](http://docs.sequelizejs.com/manual/typescript.html) and [reflect-metadata](https://www.npmjs.com/package/reflect-metadata)
40+
*sequelize-typescript* requires [sequelize](https://github.com/sequelize/sequelize), additional typings as documented [here](https://docs.sequelizejs.com/manual/typescript.html) and [reflect-metadata](https://www.npmjs.com/package/reflect-metadata)
4141
```
4242
npm install sequelize
4343
npm install @types/bluebird @types/node @types/validator
@@ -121,7 +121,7 @@ See more advanced example [here](https://github.com/RobinBuschmann/sequelize-typ
121121

122122
### `@Table`
123123
The `@Table` annotation can be used without passing any parameters. To specify some more define options, use
124-
an object literal (all [define options](http://docs.sequelizejs.com/manual/tutorial/models-definition.html#configuration)
124+
an object literal (all [define options](https://sequelize.org/v5/manual/models-definition.html#configuration)
125125
from sequelize are valid):
126126
```typescript
127127
@Table({
@@ -135,7 +135,7 @@ class Person extends Model<Person> {}
135135
Decorator | Description
136136
--------------------------------------|---------------------
137137
`@Table` | sets `options.tableName=<CLASS_NAME>` and `options.modelName=<CLASS_NAME>` automatically
138-
`@Table(options: DefineOptions)` | sets [define options](http://docs.sequelizejs.com/manual/tutorial/models-definition.html#configuration) (also sets `options.tableName=<CLASS_NAME>` and `options.modelName=<CLASS_NAME>` if not already defined by define options)
138+
`@Table(options: DefineOptions)` | sets [define options](https://sequelize.org/v5/manual/models-definition.html#configuration) (also sets `options.tableName=<CLASS_NAME>` and `options.modelName=<CLASS_NAME>` if not already defined by define options)
139139

140140
#### Primary key
141141
A primary key (`id`) will be inherited from base class `Model`. This primary key is by default an `INTEGER` and has
@@ -176,7 +176,7 @@ import {DataType} from 'sequelize-typescript';
176176
name: string;
177177
```
178178
Or for a more detailed column description, use an object literal
179-
(all [attribute options](http://docs.sequelizejs.com/manual/tutorial/models-definition.html#configuration)
179+
(all [attribute options](https://sequelize.org/v5/manual/models-definition.html#configuration)
180180
from sequelize are valid):
181181
```typescript
182182
@Column({
@@ -190,9 +190,9 @@ from sequelize are valid):
190190

191191
Decorator | Description
192192
--------------------------------------|---------------------
193-
`@Column` | tries to infer [dataType](http://docs.sequelizejs.com/manual/tutorial/models-definition.html#data-types) from js type
194-
`@Column(dataType: DateType)` | sets [dataType](http://docs.sequelizejs.com/manual/tutorial/models-definition.html#data-types) explicitly
195-
`@Column(options: AttributeOptions)` | sets [attribute options](http://docs.sequelizejs.com/manual/tutorial/models-definition.html#configuration)
193+
`@Column` | tries to infer [dataType](https://sequelize.org/v5/manual/models-definition.html#data-types) from js type
194+
`@Column(dataType: DataType)` | sets [dataType](https://sequelize.org/v5/manual/models-definition.html#data-types) explicitly
195+
`@Column(options: AttributeOptions)` | sets [attribute options](https://sequelize.org/v5/manual/models-definition.html#configuration)
196196

197197
#### *Shortcuts*
198198
If you're in love with decorators: *sequelize-typescript* provides some more of them. The following decorators can be
@@ -238,7 +238,7 @@ class Person extends Model<Person> {
238238

239239
## Usage
240240
Except for minor variations *sequelize-typescript* will work like pure sequelize.
241-
(See sequelize [docs](http://docs.sequelizejs.com/manual/tutorial/models-usage.html))
241+
(See sequelize [docs](https://docs.sequelizejs.com/manual/tutorial/models-usage.html))
242242
### Configuration
243243
To make the defined models available, you have to configure a `Sequelize` instance from `sequelize-typescript`(!).
244244
```typescript
@@ -348,7 +348,7 @@ person.save();
348348

349349
### Find and update
350350
Finding and updating entries does also work like using native sequelize. So see sequelize
351-
[docs](http://docs.sequelizejs.com/manual/tutorial/models-usage.html) for more details.
351+
[docs](https://docs.sequelizejs.com/manual/tutorial/models-usage.html) for more details.
352352
```typescript
353353
Person
354354
.findOne()
@@ -717,7 +717,7 @@ validation instead, you can do so by simply adding the validate options *as* dec
717717
So that `validate.isEmail=true` becomes `@IsEmail`, `validate.equals='value'` becomes `@Equals('value')`
718718
and so on. Please notice that a validator that expects a boolean is translated to an annotation without a parameter.
719719

720-
See sequelize [docs](http://docs.sequelizejs.com/manual/tutorial/models-definition.html#validations)
720+
See sequelize [docs](https://sequelize.org/v5/manual/models-definition.html#validations)
721721
for all validators.
722722

723723
### Exceptions
@@ -785,7 +785,7 @@ export class Shoe extends Model<Shoe> {
785785

786786
## Scopes
787787
Scopes can be defined with annotations as well. The scope options are identical to native
788-
sequelize (See sequelize [docs](http://docs.sequelizejs.com/manual/tutorial/scopes.html) for more details)
788+
sequelize (See sequelize [docs](https://docs.sequelizejs.com/manual/tutorial/scopes.html) for more details)
789789

790790
### `@DefaultScope` and `@Scopes`
791791
```typescript

Diff for: examples/simple/package-lock.json

+34-38
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: examples/simple/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"dependencies": {
1818
"body-parser": "^1.18.3",
1919
"express": "^4.16.4",
20-
"sequelize": "^5.1.0",
20+
"sequelize": "^5.15.1",
2121
"sequelize-typescript": "^1.0.0-alpha.9",
2222
"strong-error-handler": "^3.2.0"
2323
}

0 commit comments

Comments
 (0)