https://github.com/lenra-io/client-lib-js

A lib to Let you create your JavaScript/TypeScript application with Lenra backend
https://github.com/lenra-io/client-lib-js

client javascript js lenra lib ts typescript

Last synced: about 1 month ago
JSON representation

A lib to Let you create your JavaScript/TypeScript application with Lenra backend

• Host: GitHub
• URL: https://github.com/lenra-io/client-lib-js
• Owner: lenra-io
• License: mit
• Created: 2023-08-17T12:19:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-08T17:25:43.000Z (11 months ago)
• Last Synced: 2024-11-14T14:43:38.864Z (about 1 month ago)
• Topics: client, javascript, js, lenra, lib, ts, typescript
• Language: TypeScript
• Homepage:
• Size: 231 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]






Lenra's JavaScript client lib


  


    Let you create your JavaScript application with Lenra backend.

    


    


    Report Bug

    ·

    Request Feature

  



## Prerequisites

Add the dependency to your project:

```console

npm i @lenra/client

```

(back to top)


## Usage

Create a `LenraApp` in your :

```javascript

import { LenraApp } from '@lenra/client';

const app = new LenraApp({

    appName: "Example Client",

    clientId: "XXX-XXX-XXX",

});

```

Authenticate the user and open the websocket connection:

```javascript

app.connect();

```

You also can manage them separatly:

  

```javascript

const token = app.authenticate();

app.openSocket(token);

```

Or just open the websocket connection without authentication:

```javascript

app.openSocket();

```

This while automatically start the authentication flow.

You can then connect to a Lenra route to use it data:

```javascript

const route = app.route(`/${counter.id}`, (data) => {

    // Handle data

});

```

You can also call a listener given by the route:

```javascript

// calling directly the listener

button1.onclick = () => {

  data.increment().then(() => {

      // When the listener is finished

  });

};

// or from the route

button2.onclick = () => {

  route.callListener(data.decrement).then(() => {

      // When the listener is finished

  });

};

```

This [the full example](./example/src/index.js) for more informations.

For the web target, you also have to add the following JavaScript to a redirect file (default to `redirect.html`) to handle OAuth2 redirection (see the [example](./example/redirect.html)):

```javascript

window.onload = function() {

  window.opener.postMessage(window.location.href, `${window.location.protocol}//${window.location.host}`);

}

```

(back to top)


## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please open an issue with the tag "enhancement".

Don't forget to give the project a star if you liked it! Thanks again!

(back to top)


## License

Distributed under the **MIT** License. See [LICENSE](./LICENSE) for more information.

(back to top)


## Contact

Lenra - [@lenra_dev](https://twitter.com/lenra_dev) - [email protected]

Project Link: [https://github.com/lenra-io/client-lib-js](https://github.com/lenra-io/client-lib-js)

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/lenra-io/client-lib-js.svg?style=for-the-badge

[contributors-url]: https://github.com/lenra-io/client-lib-js/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/lenra-io/client-lib-js.svg?style=for-the-badge

[forks-url]: https://github.com/lenra-io/client-lib-js/network/members

[stars-shield]: https://img.shields.io/github/stars/lenra-io/client-lib-js.svg?style=for-the-badge

[stars-url]: https://github.com/lenra-io/client-lib-js/stargazers

[issues-shield]: https://img.shields.io/github/issues/lenra-io/client-lib-js.svg?style=for-the-badge

[issues-url]: https://github.com/lenra-io/client-lib-js/issues

[license-shield]: https://img.shields.io/github/license/lenra-io/client-lib-js.svg?style=for-the-badge

[license-url]: https://github.com/lenra-io/client-lib-js/blob/master/LICENSE