xo-lib
Library to connect to XO-Server
Install
Installation of the npm package :
npm install --save xo-lib copy
Usage
If the URL is not provided and the current environment is a web
browser, the location of the current page will be used.
import Xo from 'xo-lib'
// Connect to XO.
const xo = new Xo ({ url: 'https://xo.company.tld' })
// Let's start by opening the connection.
await xo. open ()
// Must sign in before being able to call any methods (all calls will
// be buffered until signed in).
await xo. signIn ({
email: 'admin@admin.net' ,
password: 'admin' ,
})
console ( 'signed as' , xo.user) copy
The credentials can also be passed directly to the constructor:
const xo = Xo ({
url: 'https://xo.company.tld' ,
credentials: {
email: 'admin@admin.net' ,
password: 'admin' ,
},
})
xo. open ()
xo. on ( 'authenticated' , () => {
console. log (xo.user)
}) copy
If the URL is not provided and the current environment is a web
browser, the location of the current page will be used.
Connection
await xo. open ()
console. log ( 'connected' ) copy
Disconnection
xo. close ()
console. log ( 'disconnected' ) copy
Method call
const token = await xo. call ( 'token.create' )
console. log ( 'Token created' , token) copy
Status
The connection status is available through the status property which
is open , connecting or closed .
console. log ( '%s to xo-server' , xo.status) copy
Current user
Information about the user account used to sign in is available
through the user property.
console. log ( 'Current user is' , xo.user) copy
This property is null when the status is not connected.
Events
xo. on ( 'open' , () => {
console. log ( 'connected' )
}) copy
xo. on ( 'closed' , () => {
console. log ( 'disconnected' )
}) copy
xo. on ( 'notification' , function (notif) {
console. log ( 'notification:' , notif.method, notif.params)
}) copy
xo. on ( 'authenticated' , () => {
console. log ( 'authenticated as' , xo.user)
})
xo. on ( 'authenticationFailure' , () => {
console. log ( 'failed to authenticate' )
}) copy
Contributions
Contributions are very welcomed, either on the documentation or on
the code.
You may:
report any issue
you've encountered;
fork and create a pull request.
License
AGPL-3.0-or-later © Vates SAS