2020-08-19 17:29:37 +00:00
|
|
|
<div align="center">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[](https://github.com/LemmyNet/lemmy-js-client/issues)
|
|
|
|
|
[](LICENSE)
|
|
|
|
|
|
2023-01-04 17:05:41 +00:00
|
|
|
|
2020-08-19 17:29:37 +00:00
|
|
|
</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 01:01:40 +00:00
|
|
|
### Websocket Client
|
2020-08-19 17:29:37 +00:00
|
|
|
|
2022-11-21 20:49:53 +00:00
|
|
|
[LemmyWebsocket docs](https://join-lemmy.org/api/classes/LemmyWebsocket.html)
|
2020-08-19 17:29:37 +00:00
|
|
|
|
2021-08-23 01:01:40 +00:00
|
|
|
```ts
|
2023-01-04 17:05:41 +00:00
|
|
|
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 01:01:40 +00:00
|
|
|
|
2023-01-04 17:05:41 +00:00
|
|
|
let form: Login = {
|
2021-08-23 01:01:40 +00:00
|
|
|
username_or_email: "my_email@email.tld",
|
|
|
|
|
password: "my_pass",
|
2023-01-04 17:05:41 +00:00
|
|
|
};
|
2021-08-23 01:01:40 +00:00
|
|
|
|
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 01:01:40 +00:00
|
|
|
### HTTP Client
|
|
|
|
|
|
2022-11-21 20:49:53 +00:00
|
|
|
[LemmyHttp docs](https://join-lemmy.org/api/classes/LemmyHttp.html)
|
2020-08-19 17:29:37 +00:00
|
|
|
|
2021-08-23 01:01:40 +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?);
|
2023-03-17 15:33:57 +00:00
|
|
|
let jwt = await client.login(loginForm).jwt;
|
2020-08-20 02:25:21 +00:00
|
|
|
```
|
2023-01-04 17:05:41 +00:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
You can use [yalc](https://github.com/wclr/yalc) to develop and test changes locally:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
yarn global add yalc
|
|
|
|
|
|
|
|
|
|
# Go to lemmy-js-client dir
|
|
|
|
|
yalc publish --push
|
|
|
|
|
|
|
|
|
|
# Go to your client dir
|
|
|
|
|
yalc add lemmy-js-client
|
|
|
|
|
|
|
|
|
|
# To do updates, go back to the lemmy-js-client dir
|
|
|
|
|
# This also updates it, in every dir you've added it.
|
|
|
|
|
yalc publish --push
|
|
|
|
|
```
|
