mirror of https://github.com/LemmyNet/lemmy-js-client.git synced 2024-11-26 06:11:14 +00:00

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

Find a file

Dessalines 817baf35bb Adding some types from lemmy/main.		2024-02-16 09:46:06 -05:00
.github	Adding sleeplessone1917 to codeowners	2023-05-15 15:23:45 -04:00
.husky	Migrate from yarn to pnpm. (#236 )	2024-01-28 22:08:00 -05:00
src	Adding some types from lemmy/main.	2024-02-16 09:46:06 -05:00
.eslintrc.json	#186 wrap bare strings to Error object (#207 )	2023-10-26 11:56:24 -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	Migrate from yarn to pnpm. (#236 )	2024-01-28 22:08:00 -05:00
copy_generated_types_from_lemmy.sh	Updating types from lemmy. (#209 )	2023-10-31 09:00:44 -04:00
deploy.sh	Migrate from yarn to pnpm. (#236 )	2024-01-28 22:08:00 -05:00
LICENSE	Initial commit.	2020-08-19 13:29:37 -04:00
package.json	Migrate from yarn to pnpm. (#236 )	2024-01-28 22:08:00 -05:00
pnpm-lock.yaml	Migrate from yarn to pnpm. (#236 )	2024-01-28 22:08:00 -05:00
putTypesInIndex.js	Updating moderator_view.	2023-08-29 15:53:23 -04:00
README.md	Migrate from yarn to pnpm. (#236 )	2024-01-28 22:08:00 -05:00
tsconfig.json	Make private class properties actually private (#128 )	2023-06-05 19:32:23 -04:00

README.md

lemmy-js-client

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

Installation

pnpm install 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:

pnpm i --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