Lightstreamer Web Client 8.1.0-beta3 API Reference
The library can also be used inside a Web Worker. The documentation highlights which class can or can't be used on such environment.
Depending on the chosen deployment architecture, on the browser in use, and on some configuration parameters, the Web Client Library will try to connect to the designated Lightstreamer Server in the best possible way. A Deployment Configuration Matrix is available online, which summarizes the client-side combinations and the instructions on which settings to use to guarantee that an optimal connection is established. See the legend on the second tab to learn about the meaning of each column.
More introductory notes are provided in the Web Client Guide document that can be found in the Github project. Look for the relevant tag.
To have a quick overview of the library, start digging into the API from the LightstreamerClient object.
Check out the available examples and associated README to learn more.
If there is any issue, you can find a solution on our public forum.
Note the following documentation convention:
Function arguments qualified as
<optional> can be omitted only if not followed by further arguments.
In some cases, arguments that can be omitted (subject to the same restriction) may not be qualified as
<optional>, but their optionality will be clear from the description.