From 3fdc55b4a713024c5d31024b449d26eff7734c59 Mon Sep 17 00:00:00 2001 From: Mikael Finstad Date: Tue, 9 Nov 2021 22:01:38 +0700 Subject: [PATCH] Remove references of incorrect `options` argument for `companion.socket` (#3307) remove socket options from docs and examples. It was never an option. See #3306 --- examples/aws-companion/server.js | 2 +- examples/uppy-with-companion/server/index.js | 2 +- packages/@uppy/companion/README.md | 2 +- website/src/_posts/2020-03-custom-providers.md | 2 +- website/src/docs/companion.md | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/aws-companion/server.js b/examples/aws-companion/server.js index 18913d7cde..dde6c926dd 100644 --- a/examples/aws-companion/server.js +++ b/examples/aws-companion/server.js @@ -52,4 +52,4 @@ const server = app.listen(3020, () => { console.log('listening on port 3020') }) -companion.socket(server, options) +companion.socket(server) diff --git a/examples/uppy-with-companion/server/index.js b/examples/uppy-with-companion/server/index.js index 2bb6d8069f..f2e55ef800 100644 --- a/examples/uppy-with-companion/server/index.js +++ b/examples/uppy-with-companion/server/index.js @@ -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}`) diff --git a/packages/@uppy/companion/README.md b/packages/@uppy/companion/README.md index 345311e6d6..991500f053 100644 --- a/packages/@uppy/companion/README.md +++ b/packages/@uppy/companion/README.md @@ -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 diff --git a/website/src/_posts/2020-03-custom-providers.md b/website/src/_posts/2020-03-custom-providers.md index 142fa23d5f..d2fcb7dff5 100644 --- a/website/src/_posts/2020-03-custom-providers.md +++ b/website/src/_posts/2020-03-custom-providers.md @@ -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`) diff --git a/website/src/docs/companion.md b/website/src/docs/companion.md index 23e0993d1c..3fd3f50a97 100644 --- a/website/src/docs/companion.md +++ b/website/src/docs/companion.md @@ -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