Skip to content

Commit

Permalink
[docs] Fix the default value of the 'origins' parameter (#3464)
Browse files Browse the repository at this point in the history
Fix documentation about default origins value. The default should read `*:*` instead of `*
  • Loading branch information
JonaMX authored and darrachequesne committed Sep 20, 2019
1 parent 1150eb5 commit 8227192
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Exposed by `require('socket.io')`.
- `path` _(String)_: name of the path to capture (`/socket.io`)
- `serveClient` _(Boolean)_: whether to serve the client files (`true`)
- `adapter` _(Adapter)_: the adapter to use. Defaults to an instance of the `Adapter` that ships with socket.io which is memory based. See [socket.io-adapter](https://github.com/socketio/socket.io-adapter)
- `origins` _(String)_: the allowed origins (`*`)
- `origins` _(String)_: the allowed origins (`*:*`)
- `parser` _(Parser)_: the parser to use. Defaults to an instance of the `Parser` that ships with socket.io. See [socket.io-parser](https://github.com/socketio/socket.io-parser).

Works with and without `new`:
Expand Down

0 comments on commit 8227192

Please # to comment.