Typo in solidWs usage in documentation

Description:
In the usage examples within the README, the solidWs function is imported as SolidWs but used as solidWs. For consistency and convention in JavaScript (camelCase for functions), the import should be changed to solidWs.

Proposed fix:
In the "Short way" and "Long way" examples, update the import statement to:

var solidWs = require('solid-ws')

This will maintain consistency with the function call solidWs(server).

Fix nodeSolidServer#26: Correct solidWs naming and syntax error in RE…

@bourgeoa

The README still has SolidWs instead of solidWs, which is inconsistent with the function call. This should be fixed for clarity and convention. Any updates on this?

var SolidWs = require('solid-ws')
var ldnode = require('ldnode')

var server = ldnode.createServer()
solidWs(server)

server.listen(port, function () {
  console.log('Solid server started')
})

@bourgeoa ?

@melvincarvalho

@melvincarvalho — Can you submit a PR that would fix this? That is probably the fastest way to move it forward...

@melvincarvalho

@melvincarvalho — Sorry, GitHub UI changes led me to overlook that you have submitted such a PR as #27: Fix #26: Correct solidWs naming and syntax error in README.

Navigation Menu

Repository navigation

Typo in solidWs usage in documentation #26

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Typo in solidWs usage in documentation #26

Description

Activity

melvincarvalho commented on Mar 18, 2025

TallTed commented on Mar 18, 2025

TallTed commented on Mar 18, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions