Neos.

Neos.

Neos.

Constructor

new Neos.(optionsopt)

Source:
Creates an instance of the NeosJS Client.
Parameters:
Name Type Attributes Description
options NeosGeneratorOptions <optional>
Properties
Name Type Attributes Default Description
AutoReadMessages boolean <optional>
true Auto Mark messages as Read in the API when handled by the Neos#messageReceived event.
OnlineState OnlineStatus <optional>
"Online" Online User Status, Displayed in User List.
StatusInterval number <optional>
60 How Frequent to update the user status. Will trigger Neos#statusUpdated.
NeosVersion string <optional>
"Neos.js ${PackageVersion}" Defaults to the Library version. Use to display a custom "Neos Version".
CompatabilityHash string <optional>
"Neos.js ${PackageVersion}" Determines Version Compatability Hash, Used by clients to determing if a session is the same version.
UpdateInterval number <optional>
1000 Internal Update interval in `ms`. Reccomended: 1000.
Update boolean <optional>
true Enable State of the Internal Update loop. Only reccomend setting this to `false` if you know what you are doing.
MultiMessageDelay number <optional>
1100 MultiMessage Delay for sending messages in `ms`. Reccomend over `1000ms`.

Extends

  • EventEmitter