lemmy-js-client 1.0.0-alpha.0 → 1.0.0-alpha.2

package/README.md

@@ -26,7 +26,11 @@ import { LemmyHttp, Login } from "lemmy-js-client";
 
 // Build the client
 const baseUrl = "https://lemmy.ml";
-const client: LemmyHttp = new LemmyHttp(baseUrl);
+const headers = {["x-real-ip": ...]};
+const client: LemmyHttp = new LemmyHttp(baseUrl, {
+  headers,
+  useRequestState: true
+});
 
 // Build the login form
 const loginForm: Login = {
@@ -35,15 +39,40 @@ const loginForm: Login = {
 };
 
 // Login and set the client headers with your jwt
-const { jwt } = await client.login(loginForm);
-client.setHeaders({ Authorization: `Bearer ${jwt}` });
+const loginRes = await client.login(loginForm);
+
+// Make sure its successful
+if (loginRes.state === "success") {
+  const jwt = login.data.jwt;
+  client.setHeaders({ Authorization: `Bearer ${jwt}` });
+} else if (loginRes.state === "failed") {
+  const err = login.err;
+}
 
 // Fetch top posts for the day
 const getPostsForm: GetPosts = {
   sort: "TopDay",
   type_: "Local",
 };
-const posts = await client.getPosts(getPostsForm);
+const postsRes = await client.getPosts(getPostsForm);
+
+// Handle the different request states
+switch (postsRes.state) {
+  case "empty": {
+    break;
+  }
+  case "loading": {
+    break;
+  }
+  case "failed": {
+    const err = postsRes.err;
+    break;
+  }
+  case "success": {
+    const data = postsRes.data;
+    break;
+  }
+}
 ```
 
 ## Development
@@ -52,6 +81,12 @@ Use `pnpm add` to develop and test changes locally:
 
 `pnpm add path/to/lemmy-js-client`
 
+Alternatively, use `yalc publish` and `yalc add lemmy-js-client`
+
+## Generating typescript types from lemmy structs
+
+Run `./scripts/copy_generated_types_from_lemmy.sh`
+
 ## OpenAPI
 
 To generate OpenAPI docs, run `pnpm tsoa`