Skip to content

Commit

Permalink
Remove references of incorrect options argument for `companion.sock…
Browse files Browse the repository at this point in the history
…et` (#3307)

remove socket options

from docs and examples. It was never an option. See #3306
  • Loading branch information
mifi committed Nov 9, 2021
1 parent bfe6598 commit 3fdc55b
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion examples/aws-companion/server.js
Expand Up @@ -52,4 +52,4 @@ const server = app.listen(3020, () => {
console.log('listening on port 3020')
})

companion.socket(server, options)
companion.socket(server)
2 changes: 1 addition & 1 deletion examples/uppy-with-companion/server/index.js
Expand Up @@ -66,7 +66,7 @@ app.use((err, req, res) => {
res.status(err.status || 500).json({ message: err.message, error: err })
})

companion.socket(app.listen(3020), uppyOptions)
companion.socket(app.listen(3020))

console.log('Welcome to Companion!')
console.log(`Listening on http://0.0.0.0:${3020}`)
2 changes: 1 addition & 1 deletion packages/@uppy/companion/README.md
Expand Up @@ -57,7 +57,7 @@ To enable companion socket for realtime feed to the client while upload is going
// ...
const server = app.listen(PORT)

companion.socket(server, options)
companion.socket(server)
```

### Run as standalone server
Expand Down
2 changes: 1 addition & 1 deletion website/src/_posts/2020-03-custom-providers.md
Expand Up @@ -113,7 +113,7 @@ app.use((req, res, next) => {
return res.status(404).json({ message: 'Not Found' })
})

companion.socket(app.listen(3020), companionOptions)
companion.socket(app.listen(3020))

console.log('Welcome to Companion!')
console.log(`Listening on http://0.0.0.0:3020`)
Expand Down
4 changes: 2 additions & 2 deletions website/src/docs/companion.md
Expand Up @@ -98,10 +98,10 @@ Then, add the Companion WebSocket server for realtime upload progress, using the
```js
const server = app.listen(PORT)

companion.socket(server, options)
companion.socket(server)
```

This takes your `server` instance and [Options](#Options) as parameters.
This takes your `server` instance as an argument.

### Running as a standalone server

Expand Down

0 comments on commit 3fdc55b

Please sign in to comment.