2020-08-19 17:29:37 +00:00
< div align = "center" >
[](https://github.com/LemmyNet/lemmy-js-client/issues)
[](LICENSE)
< / div >
# lemmy-js-client
A javascript / typescript http and websocket client and type system for [Lemmy ](https://github.com/LemmyNet/lemmy ).
## Installation
`yarn add lemmy-js-client`
## Usage
2021-08-23 00:59:28 +00:00
### Websocket Client
2020-08-19 17:29:37 +00:00
2021-08-23 00:59:28 +00:00
[LemmyWebsocket docs ](classes/LemmyWebsocket.html )
2020-08-19 17:29:37 +00:00
2021-08-23 00:59:28 +00:00
```ts
import { Login, LemmyWebsocket } from 'lemmy-js-client';
2020-08-19 17:29:37 +00:00
2020-08-20 02:25:21 +00:00
let client: LemmyWebsocket = new LemmyWebsocket();
2021-08-23 00:59:28 +00:00
let form: Login {
username_or_email: "my_email@email.tld",
password: "my_pass",
};
2020-08-20 02:25:21 +00:00
this.ws.send(client.login(form));
2020-08-19 17:29:37 +00:00
```
2021-08-23 00:59:28 +00:00
### HTTP Client
[LemmyHttp docs ](classes/LemmyHttp.html )
2020-08-19 17:29:37 +00:00
2021-08-23 00:59:28 +00:00
```ts
2020-08-20 02:25:21 +00:00
import { LemmyHttp } from 'lemmy-js-client';
2021-03-29 14:29:27 +00:00
let baseUrl = 'https://lemmy.ml';
2020-11-12 19:42:31 +00:00
let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
2020-08-20 02:25:21 +00:00
let jwt = await client.httpLogin(loginForm).jwt;
```
2020-08-19 17:29:37 +00:00
## Support / Donate
Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
- [Support on Liberapay ](https://liberapay.com/Lemmy ).
- [Support on Patreon ](https://www.patreon.com/dessalines ).
- [Support on OpenCollective ](https://opencollective.com/lemmy ).
- [List of Sponsors ](https://dev.lemmy.ml/sponsors ).
### Crypto
- bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
- monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
