Sondro / lemmy-js-client

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub tag (latest SemVer) GitHub issues License GitHub stars

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

About

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

License:GNU Affero General Public License v3.0


Languages

Language:TypeScript 98.6%Language:Shell 0.7%Language:JavaScript 0.7%