lemmy-js-client/README.md
Dessalines 39f247173d
Migrate from yarn to pnpm. (#236)
* Migrate from yarn to pnpm.

* Fixing woodpecker.

* 0.19.3-alpha.3

* Fixing publish.

* 0.19.3-alpha.4

* Upgrading deps.

* 0.19.3-alpha.5

* Fix package.json.

* 0.19.3-alpha.6
2024-01-28 22:08:00 -05:00

1.3 KiB

GitHub tag (latest SemVer) GitHub issues License GitHub stars

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