ソースを参照

Update WebClientService.init docstring

Lennart Grahl 5 年 前
コミット
c5b7ec30e5
1 ファイル変更6 行追加0 行削除
  1. 6 0
      src/services/webclient.ts

+ 6 - 0
src/services/webclient.ts

@@ -447,6 +447,12 @@ export class WebClientService {
     /**
      * Initialize the webclient service.
      *
+     * @param keyStore Key store to be used. Will create a new one if `undefined` or reuse the currently used one if
+     *   `reuse`.
+     * @param peerTrustedKey The peer's trusted key. Will not use this feature if `undefined` or reuse the currently
+     *   used one if `reuse`.
+     * @param resume Whether the previous session can be resumed.
+     *
      * Warning: Do not call this with `flags.resume` set to `false` in case
      *          messages can be queued by the user.
      */