Skip to content
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.

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

fix: resolve CI issues #163

Merged
merged 5 commits into from
Jan 1, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Below is a table containing all of the possible configuration options for `serve

| Property | Type | Description | Default |
| -------- | ---- | ----------- | ------- |
| library | `Function` | Custom mysql library | `require('mysql')` |
| library | `Function` | Custom mysql library | `require('mysql2')` |
| promise | `Function` | Custom promise library | `Promise` |
| backoff | `String` or `Function` | Backoff algorithm to be used when retrying connections. Possible values are `full` and `decorrelated`, or you can also specify your own algorithm. See [Connection Backoff](#connection-backoff) for more information. | `full` |
| base | `Integer` | Number of milliseconds added to random backoff values. | `2` |
Expand Down Expand Up @@ -207,7 +207,7 @@ library: require('aws-sdk-xray-node')(require('mysql'));
```

### Consideration when using TypeScript
Currently, our type definitions rely on the `mysql` module.
Currently, our type definitions rely on the `mysql2` module.
In order to use a custom library, you will need to do something along the following snippet:

```typescript
Expand Down
7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@
"aurora"
],
"author": "Jeremy Daly <[email protected]>",
"maintainers": [
{
"name": "Naor Peled",
"email": "[email protected]",
"url": "https://naor.dev"
}
],
"license": "MIT",
"bugs": {
"url": "https://github.com/jeremydaly/serverless-mysql/issues"
Expand Down
Loading