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.
| .github | ||
| .husky | ||
| src | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierrc.json | ||
| .woodpecker.yml | ||
| copy_generated_types_from_lemmy.sh | ||
| deploy.sh | ||
| LICENSE | ||
| package.json | ||
| putTypesInIndex.js | ||
| README.md | ||
| tsconfig.json | ||
| yarn.lock | ||
lemmy-js-client
A javascript / typescript http client and type system for Lemmy.
Installation
yarn add lemmy-js-client
Usage
HTTP Client
import { LemmyHttp, Login } from 'lemmy-js-client';
let baseUrl = 'https://lemmy.ml';
let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
let loginForm: Login = {
username_or_email: "my_name",
password: "my_pass",
};
let jwt = await client.login(loginForm).jwt;
Development
You can use 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