Skip to content

Commit ae4c2ec

Browse files
chores: update dependencies and docs (#58)
1 parent cf2b74d commit ae4c2ec

File tree

17 files changed

+4645
-8879
lines changed

17 files changed

+4645
-8879
lines changed

.eslintrc.js

Lines changed: 0 additions & 17 deletions
This file was deleted.

.github/workflows/node.js.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212

1313
strategy:
1414
matrix:
15-
node-version: [16.x, 18.x, 20.x]
15+
node-version: [18.x, 20.x, 22.x]
1616

1717
steps:
1818
- uses: actions/checkout@v3

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
node_modules
22
.nyc_output
3+
.tap
34
lib
45
types

docs/.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/README.md

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,20 @@
1-
sequelize-pool
1+
**sequelize-pool**
22

3-
# sequelize-pool
3+
***
44

5-
## Table of contents
5+
# sequelize-pool
66

7-
### Classes
7+
## Classes
88

99
- [AggregateError](classes/AggregateError.md)
1010
- [Pool](classes/Pool.md)
1111
- [TimeoutError](classes/TimeoutError.md)
1212

13-
### Interfaces
13+
## Interfaces
1414

1515
- [FactoryOptions](interfaces/FactoryOptions.md)
1616

17-
### Type Aliases
18-
19-
- [FactoryLogger](README.md#factorylogger)
20-
- [LogLevel](README.md#loglevel)
21-
2217
## Type Aliases
2318

24-
### FactoryLogger
25-
26-
Ƭ **FactoryLogger**: (`message`: `string`, `level`: [`LogLevel`](README.md#loglevel)) => `void`
27-
28-
#### Type declaration
29-
30-
▸ (`message`, `level`): `void`
31-
32-
##### Parameters
33-
34-
| Name | Type |
35-
| :------ | :------ |
36-
| `message` | `string` |
37-
| `level` | [`LogLevel`](README.md#loglevel) |
38-
39-
##### Returns
40-
41-
`void`
42-
43-
___
44-
45-
### LogLevel
46-
47-
Ƭ **LogLevel**: ``"verbose"`` \| ``"info"`` \| ``"warn"`` \| ``"error"``
19+
- [FactoryLogger](type-aliases/FactoryLogger.md)
20+
- [LogLevel](type-aliases/LogLevel.md)

docs/classes/AggregateError.md

Lines changed: 56 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,157 +1,147 @@
1+
[**sequelize-pool**](../README.md)
2+
3+
***
4+
15
[sequelize-pool](../README.md) / AggregateError
26

37
# Class: AggregateError
48

59
A wrapper for multiple Errors
610

7-
## Hierarchy
11+
## Extends
812

913
- `Error`
1014

11-
**`AggregateError`**
12-
13-
## Table of contents
14-
15-
### Constructors
16-
17-
- [constructor](AggregateError.md#constructor)
18-
19-
### Properties
20-
21-
- [errors](AggregateError.md#errors)
22-
- [message](AggregateError.md#message)
23-
- [name](AggregateError.md#name)
24-
- [stack](AggregateError.md#stack)
25-
- [prepareStackTrace](AggregateError.md#preparestacktrace)
26-
- [stackTraceLimit](AggregateError.md#stacktracelimit)
15+
## Constructors
2716

28-
### Methods
17+
### Constructor
2918

30-
- [toString](AggregateError.md#tostring)
31-
- [captureStackTrace](AggregateError.md#capturestacktrace)
19+
> **new AggregateError**(`errors`): `AggregateError`
3220
33-
## Constructors
21+
#### Parameters
3422

35-
### constructor
23+
##### errors
3624

37-
**new AggregateError**(`errors`)
25+
`Error`[]
3826

39-
#### Parameters
27+
#### Returns
4028

41-
| Name | Type |
42-
| :------ | :------ |
43-
| `errors` | `Error`[] |
29+
`AggregateError`
4430

4531
#### Overrides
4632

47-
Error.constructor
33+
`Error.constructor`
4834

4935
## Properties
5036

5137
### errors
5238

53-
**errors**: `Error`[]
39+
> **errors**: `Error`[]
5440
55-
___
41+
***
5642

5743
### message
5844

59-
**message**: `string`
45+
> **message**: `string`
6046
6147
#### Inherited from
6248

63-
Error.message
49+
`Error.message`
6450

65-
___
51+
***
6652

6753
### name
6854

69-
**name**: `string`
55+
> **name**: `string`
7056
7157
#### Inherited from
7258

73-
Error.name
59+
`Error.name`
7460

75-
___
61+
***
7662

77-
### stack
63+
### stack?
7864

79-
`Optional` **stack**: `string`
65+
> `optional` **stack**: `string`
8066
8167
#### Inherited from
8268

83-
Error.stack
69+
`Error.stack`
8470

85-
___
71+
***
8672

87-
### prepareStackTrace
73+
### prepareStackTrace()?
8874

89-
`Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
75+
> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
9076
91-
#### Type declaration
77+
Optional override for formatting stack traces
9278

93-
▸ (`err`, `stackTraces`): `any`
79+
#### Parameters
9480

95-
Optional override for formatting stack traces
81+
##### err
82+
83+
`Error`
9684

97-
##### Parameters
85+
##### stackTraces
9886

99-
| Name | Type |
100-
| :------ | :------ |
101-
| `err` | `Error` |
102-
| `stackTraces` | `CallSite`[] |
87+
`CallSite`[]
10388

104-
##### Returns
89+
#### Returns
10590

10691
`any`
10792

108-
**`See`**
93+
#### See
10994

11095
https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces
11196

11297
#### Inherited from
11398

114-
Error.prepareStackTrace
99+
`Error.prepareStackTrace`
115100

116-
___
101+
***
117102

118103
### stackTraceLimit
119104

120-
`Static` **stackTraceLimit**: `number`
105+
> `static` **stackTraceLimit**: `number`
121106
122107
#### Inherited from
123108

124-
Error.stackTraceLimit
109+
`Error.stackTraceLimit`
125110

126111
## Methods
127112

128-
### toString
113+
### toString()
114+
115+
> **toString**(): `string`
129116
130-
**toString**(): `string`
117+
Returns a string representation of an object.
131118

132119
#### Returns
133120

134121
`string`
135122

136-
___
123+
***
137124

138-
### captureStackTrace
125+
### captureStackTrace()
139126

140-
`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
127+
> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
141128
142129
Create .stack property on a target object
143130

144131
#### Parameters
145132

146-
| Name | Type |
147-
| :------ | :------ |
148-
| `targetObject` | `Object` |
149-
| `constructorOpt?` | `Function` |
133+
##### targetObject
134+
135+
`Object`
136+
137+
##### constructorOpt?
138+
139+
`Function`
150140

151141
#### Returns
152142

153143
`void`
154144

155145
#### Inherited from
156146

157-
Error.captureStackTrace
147+
`Error.captureStackTrace`

0 commit comments

Comments
 (0)