max-mapper / max-mapper/websocket-stream
Typescript createServer typing not correct
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 667
- Forks
- 110
- PR merge metrics
- No merged PRs in 30d
Description
In index.d.ts
```typescript
function createServer(opts?: WebSocket.ServerOptions, callback?: () => void): Server;
```
Should become
```typescript
function createServer(opts?: WebSocket.ServerOptions, callback?: (socket: WebSocketDuplex) => void): Server;
```
Since the callback is missing the parameter, typescript isn't allowing to pass a handler function
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open index.d.ts and inspect the createServer declaration. Update the callback type to include the WebSocketDuplex parameter, then verify that a handler function accepting that parameter is accepted by the TypeScript definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100