mirror of
https://github.com/LemmyNet/lemmy-js-client.git
synced 2024-12-22 19:01:27 +00:00
A javascript / typescript http and websocket client and type system for Lemmy.
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> |
||
|---|---|---|
| .github | ||
| .husky | ||
| src | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierrc.json | ||
| .woodpecker.yml | ||
| copy_generated_types_from_lemmy.sh | ||
| deploy.sh | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| putTypesInIndex.js | ||
| README.md | ||
| tsconfig.json | ||
lemmy-js-client
A javascript / typescript http client and type system for Lemmy.
Installation
pnpm install lemmy-js-client
Usage
HTTP Client
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