docs: add docs for JS BaseDeltaChat
#7203
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Regarding the `@deprecated` addition: it's not clear to me why the `listAccounts` function exists, why `getAllAccounts` gets special treatment. It has been there ever since the introduction of JSON-RPC. Maybe it's because of the existence of `getContextEvents`, which has to do with accounts. But hopefully the new doc on `getContextEvents` compensates for this.
Simon-Laux
reviewed
Oct 2, 2025
Comment on lines
+73
to
+75
| /** | ||
| * @deprecated use {@linkcode BaseDeltaChat.rpc.getAllAccounts} instead. | ||
| */ |
There was a problem hiding this comment.
FTR: the original idea of these method is to be a convenience method, like python bindings which create some wrappers around the RPC functions. But I totally agree that it is not needed here and would only increase maintenance burden.
I also tried auto generating some convince classes but ultimately scraped the idea: #3697
would need much discipline in naming things and order of method arguments and still add extra complexity that is not worth the reward.
this method is basically a leftover of that idea.
There was a problem hiding this comment.
Thanks for the clarification.
Simon-Laux
approved these changes
Oct 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Regarding the
@deprecatedaddition:it's not clear to me why the
listAccountsfunction exists,why
getAllAccountsgets special treatment.It has been there ever since the introduction of JSON-RPC.
Maybe it's because of the existence of
getContextEvents,which has to do with accounts.
But hopefully the new doc on
getContextEventscompensates for this.