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

Remove references of incorrect options argument for companion.socket #3307

Merged
merged 6 commits into from Nov 9, 2021
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
2 changes: 1 addition & 1 deletion website/src/docs/companion.md
Expand Up @@ -98,7 +98,7 @@ 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line also needs to be removed.

Expand Down