mirror of
https://github.com/LemmyNet/lemmy-js-client.git
synced 2024-11-01 01:59:55 +00:00
2d7a921454
The links did not work directy out of the repository on GitHub. Fixed this by adding the full path inclusive domain.
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
<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
|
|
|
|
### Websocket Client
|
|
|
|
[LemmyWebsocket docs](https://join-lemmy.org/api/classes/LemmyWebsocket.html)
|
|
|
|
```ts
|
|
import { Login, LemmyWebsocket } from 'lemmy-js-client';
|
|
|
|
let client: LemmyWebsocket = new LemmyWebsocket();
|
|
|
|
let form: Login {
|
|
username_or_email: "my_email@email.tld",
|
|
password: "my_pass",
|
|
};
|
|
|
|
this.ws.send(client.login(form));
|
|
```
|
|
|
|
### HTTP Client
|
|
|
|
[LemmyHttp docs](https://join-lemmy.org/api/classes/LemmyHttp.html)
|
|
|
|
```ts
|
|
import { LemmyHttp } from 'lemmy-js-client';
|
|
|
|
let baseUrl = 'https://lemmy.ml';
|
|
let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
|
|
let jwt = await client.httpLogin(loginForm).jwt;
|
|
```
|