mirror of
https://github.com/chatmail/core.git
synced 2026-05-07 08:56:30 +03:00
docs: add docs for JS BaseDeltaChat
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.
This commit is contained in:
@@ -35,6 +35,10 @@ export class BaseDeltaChat<
|
|||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
public transport: Transport,
|
public transport: Transport,
|
||||||
|
/**
|
||||||
|
* Whether to start calling {@linkcode RawClient.getNextEvent}
|
||||||
|
* and emitting the respective events on this class.
|
||||||
|
*/
|
||||||
startEventLoop: boolean,
|
startEventLoop: boolean,
|
||||||
) {
|
) {
|
||||||
super();
|
super();
|
||||||
@@ -44,6 +48,9 @@ export class BaseDeltaChat<
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see the constructor's `startEventLoop`
|
||||||
|
*/
|
||||||
async eventLoop(): Promise<void> {
|
async eventLoop(): Promise<void> {
|
||||||
while (true) {
|
while (true) {
|
||||||
const event = await this.rpc.getNextEvent();
|
const event = await this.rpc.getNextEvent();
|
||||||
@@ -62,10 +69,17 @@ export class BaseDeltaChat<
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated use {@linkcode BaseDeltaChat.rpc.getAllAccounts} instead.
|
||||||
|
*/
|
||||||
async listAccounts(): Promise<T.Account[]> {
|
async listAccounts(): Promise<T.Account[]> {
|
||||||
return await this.rpc.getAllAccounts();
|
return await this.rpc.getAllAccounts();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A convenience function to listen on events binned by `account_id`
|
||||||
|
* (see {@linkcode RawClient.getAllAccounts}).
|
||||||
|
*/
|
||||||
getContextEvents(account_id: number) {
|
getContextEvents(account_id: number) {
|
||||||
if (this.contextEmitters[account_id]) {
|
if (this.contextEmitters[account_id]) {
|
||||||
return this.contextEmitters[account_id];
|
return this.contextEmitters[account_id];
|
||||||
|
|||||||
Reference in New Issue
Block a user