Companion socket options?

[petrbela]

In companion's readme/docs, it says in order to enable progress updates, we should call companion.socket(server, options). After upgrading @uppy/companion to v3, the options argument is no longer accepted. What's the correct way to do this?

[Murderlon]

Hi, this seems to be incorrect in the docs. The options should be passed to the companion instance instead and socket doesn't take options.

import companion from '@uppy/companion'
import express from 'express'

const app = express()
app.use('/companion', companion.app({ /* options */ }))

cc @mifi

[mifi]

I think the socket function has never accepted an options arguemnt:

uppy/packages/@uppy/companion/src/server/socket.js

Line 13 in 6b7ad5e

module.exports = (server) => {

The correct way should just be companion.socket(server), and if you need to send any options for companion, then do like @Murderlon suggested

[Murderlon]

Closed in #3307