Skip to content

Commit 8f132b1

Browse files
chores: update dependencies and documentation (#46)
1 parent d67c719 commit 8f132b1

File tree

12 files changed

+887
-666
lines changed

12 files changed

+887
-666
lines changed

docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,42 @@ sequelize-pool
66

77
### Classes
88

9-
- [AggregateError](classes/aggregateerror.md)
10-
- [Pool](classes/pool.md)
11-
- [TimeoutError](classes/timeouterror.md)
9+
- [AggregateError](classes/AggregateError.md)
10+
- [Pool](classes/Pool.md)
11+
- [TimeoutError](classes/TimeoutError.md)
1212

1313
### Interfaces
1414

15-
- [FactoryOptions](interfaces/factoryoptions.md)
15+
- [FactoryOptions](interfaces/FactoryOptions.md)
16+
17+
### Type aliases
18+
19+
- [FactoryLogger](README.md#factorylogger)
20+
- [LogLevel](README.md#loglevel)
21+
22+
## Type aliases
23+
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"`` \| ``"error"``

docs/classes/AggregateError.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
[sequelize-pool](../README.md) / AggregateError
2+
3+
# Class: AggregateError
4+
5+
A wrapper for multiple Errors
6+
7+
## Hierarchy
8+
9+
- `Error`
10+
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+
- [stackTraceLimit](AggregateError.md#stacktracelimit)
26+
27+
### Methods
28+
29+
- [toString](AggregateError.md#tostring)
30+
- [captureStackTrace](AggregateError.md#capturestacktrace)
31+
- [prepareStackTrace](AggregateError.md#preparestacktrace)
32+
33+
## Constructors
34+
35+
### constructor
36+
37+
**new AggregateError**(`errors`)
38+
39+
#### Parameters
40+
41+
| Name | Type |
42+
| :------ | :------ |
43+
| `errors` | `Error`[] |
44+
45+
#### Overrides
46+
47+
Error.constructor
48+
49+
## Properties
50+
51+
### errors
52+
53+
**errors**: `Error`[]
54+
55+
___
56+
57+
### message
58+
59+
**message**: `string`
60+
61+
#### Inherited from
62+
63+
Error.message
64+
65+
___
66+
67+
### name
68+
69+
**name**: `string`
70+
71+
#### Inherited from
72+
73+
Error.name
74+
75+
___
76+
77+
### stack
78+
79+
`Optional` **stack**: `string`
80+
81+
#### Inherited from
82+
83+
Error.stack
84+
85+
___
86+
87+
### stackTraceLimit
88+
89+
`Static` **stackTraceLimit**: `number`
90+
91+
#### Inherited from
92+
93+
Error.stackTraceLimit
94+
95+
## Methods
96+
97+
### toString
98+
99+
**toString**(): `string`
100+
101+
#### Returns
102+
103+
`string`
104+
105+
___
106+
107+
### captureStackTrace
108+
109+
`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
110+
111+
Create .stack property on a target object
112+
113+
#### Parameters
114+
115+
| Name | Type |
116+
| :------ | :------ |
117+
| `targetObject` | `Object` |
118+
| `constructorOpt?` | `Function` |
119+
120+
#### Returns
121+
122+
`void`
123+
124+
#### Inherited from
125+
126+
Error.captureStackTrace
127+
128+
___
129+
130+
### prepareStackTrace
131+
132+
`Static` `Optional` **prepareStackTrace**(`err`, `stackTraces`): `any`
133+
134+
Optional override for formatting stack traces
135+
136+
**`see`** https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces
137+
138+
#### Parameters
139+
140+
| Name | Type |
141+
| :------ | :------ |
142+
| `err` | `Error` |
143+
| `stackTraces` | `CallSite`[] |
144+
145+
#### Returns
146+
147+
`any`
148+
149+
#### Inherited from
150+
151+
Error.prepareStackTrace

0 commit comments

Comments
 (0)