mirror of
https://github.com/LemmyNet/lemmy-js-client.git
synced 2024-11-29 15:51:12 +00:00
589f336a72
* Better readme example. * Update README.md Co-authored-by: SleeplessOne1917 <28871516+SleeplessOne1917@users.noreply.github.com> --------- Co-authored-by: SleeplessOne1917 <28871516+SleeplessOne1917@users.noreply.github.com>
55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
<div align="center">
|
|
|
|
|
|
[](https://github.com/LemmyNet/lemmy-js-client/issues)
|
|
[](LICENSE)
|
|
|
|
|
|
</div>
|
|
|
|
# lemmy-js-client
|
|
|
|
A javascript / typescript http client and type system for [Lemmy](https://github.com/LemmyNet/lemmy).
|
|
|
|
## Installation
|
|
|
|
`pnpm install lemmy-js-client`
|
|
|
|
## Usage
|
|
|
|
### HTTP Client
|
|
|
|
[LemmyHttp docs](https://join-lemmy.org/api/classes/LemmyHttp.html)
|
|
|
|
```ts
|
|
import { LemmyHttp, Login } from "lemmy-js-client";
|
|
|
|
// Build the client
|
|
const baseUrl = "https://lemmy.ml";
|
|
const client: LemmyHttp = new LemmyHttp(baseUrl);
|
|
|
|
// Build the login form
|
|
const loginForm: Login = {
|
|
username_or_email: "my_name",
|
|
password: "my_pass",
|
|
};
|
|
|
|
// Login and set the client headers with your jwt
|
|
const { jwt } = await client.login(loginForm);
|
|
client.setHeaders({ Authorization: `Bearer ${jwt}` });
|
|
|
|
// Fetch top posts for the day
|
|
const getPostsForm: GetPosts = {
|
|
sort: "TopDay",
|
|
type_: "Local",
|
|
};
|
|
const posts = await client.getPosts(getPostsForm);
|
|
```
|
|
|
|
## Development
|
|
|
|
Use `pnpm add` to develop and test changes locally:
|
|
|
|
```
|
|
pnpm add path/to/lemmy-js-client
|
|
```
|