Document logging in as a user instead of a bot.

Open
#139 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
api, authentication

Research direction

Start with the Client.login() and Client.connect() entry points shown in the issue, and check how the current login flow is described. Done means either the required connection step is documented clearly or the issue's proposed behavior change is resolved and reflected in the documentation.

Written by the indexing model from the issue text.

Description

Describe your feature

I tried this earlier:

import { Client } from "stoat.js";
const client = new Client();
client.on("ready", async (e) => console.log(e));
client.login({ email: "foo@bar.com", password: "Password12345" });

Unfortunately, it does not work. One must manually call client.connect() once the promise from login() resolves, which seems to be entirely undocumented. It would be nice if either this was not necessary, or it was documented.

Dominant language
TypeScript
Stars
285
Forks
108
Avg merge
16h 49m
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stoatchat/javascript-client-sdk

All issues in stoatchat/javascript-client-sdk

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.