Skip to content

Commit 484b269

Browse files
committed
Version 3.0.0
1 parent 633f693 commit 484b269

2 files changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,3 +839,20 @@ await Promise.all([
839839
.close(),
840840
]);
841841
```
842+
843+
### Updating to version 3.x
844+
845+
As of version 3, `@types/supertest` is an optional peer dependency, and the
846+
package exports have been tidied up. The package may no-longer work in old,
847+
unsupported versions of Node.js (prior to version 20).
848+
849+
If you are using `supertest` and TypeScript, you will need to explicitly
850+
install the necessary types:
851+
852+
```sh
853+
npm install --save-dev @types/supertest
854+
```
855+
856+
If you are using the legacy `require('superwstest').default` syntax, you will
857+
need to drop the `.default`, or update to using the modern
858+
`import 'superwstest'` syntax.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "superwstest",
3-
"version": "2.1.1",
3+
"version": "3.0.0",
44
"private": true,
55
"description": "supertest with added WebSocket capabilities",
66
"main": "./superwstest.cjs",

0 commit comments

Comments
 (0)