mirror of https://github.com/LemmyNet/lemmy-js-client.git synced 2024-11-22 20:31:12 +00:00

A javascript / typescript http and websocket client and type system for Lemmy.

Find a file

Dessalines 2f1e6d9e6b Forgot to add types.		2023-09-04 17:44:39 -04:00
.github	Adding sleeplessone1917 to codeowners	2023-05-15 15:23:45 -04:00
.husky	Upgrade deps (#23 )	2021-07-19 10:11:44 -04:00
src	Forgot to add types.	2023-09-04 17:44:39 -04:00
.eslintrc.json	Make script for adding types to index (#118 )	2023-05-11 13:10:28 -04:00
.gitignore	Adding typedoc, and code comments. Fixes #29 (#30 )	2021-08-22 21:01:40 -04:00
.prettierrc.json	Add community language (#85 )	2022-12-19 10:57:02 -05:00
.woodpecker.yml	Upgrading deps (#117 )	2023-05-10 11:15:51 -04:00
copy_generated_types_from_lemmy.sh	Generate error enum types (#161 )	2023-07-17 11:37:53 -04:00
deploy.sh	Adding new version to deploy.	2021-01-20 10:35:12 -05:00
LICENSE	Initial commit.	2020-08-19 13:29:37 -04:00
package.json	v0.19.0-rc.4	2023-09-04 16:06:16 -04:00
putTypesInIndex.js	Updating moderator_view.	2023-08-29 15:53:23 -04:00
README.md	Removing websocket. (#145 )	2023-06-21 11:40:11 -04:00
tsconfig.json	Make private class properties actually private (#128 )	2023-06-05 19:32:23 -04:00
yarn.lock	Upgrade prettier.	2023-07-12 08:37:34 -04:00

README.md

lemmy-js-client

A javascript / typescript http client and type system for Lemmy.

Installation

yarn add lemmy-js-client

Usage

HTTP Client

LemmyHttp docs

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