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.

Find a file

Dessalines 3778e7fc87 Feature/mark post as read (#21 ) * Show / hide read posts * v0.11.0-rc.13		2021-04-26 14:58:47 -04:00
src	Feature/mark post as read (#21 )	2021-04-26 14:58:47 -04:00
.drone.yml	Adding email.	2021-01-20 10:29:21 -05:00
.eslintrc.json	Initial commit.	2020-08-19 13:29:37 -04:00
.gitignore	Initial commit.	2020-08-19 13:29:37 -04:00
.prettierrc.js	Initial commit.	2020-08-19 13:29:37 -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	Feature/mark post as read (#21 )	2021-04-26 14:58:47 -04:00
README.md	Including API version in HTTP constructor.	2021-03-29 10:29:27 -04:00
tsconfig.json	Initial commit.	2020-08-19 13:29:37 -04:00
yarn.lock	Adding some comments.	2021-01-24 12:37:04 -05:00

README.md

lemmy-js-client

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

Installation

yarn add lemmy-js-client

Usage

Check out the Lemmy HTTP / websocket API for all the commands.

Websocket

import { LoginForm, LemmyWebsocket } from 'lemmy-js-client';

let client: LemmyWebsocket = new LemmyWebsocket();
this.ws.send(client.login(form));

HTTP

import { LemmyHttp } from 'lemmy-js-client';

let baseUrl = 'https://lemmy.ml';
let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
let jwt = await client.httpLogin(loginForm).jwt;

Support / Donate

Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.

Crypto

bitcoin: 1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK
ethereum: 0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01
monero: 41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV