diff options
Diffstat (limited to 'lang/js/src/index.js')
| -rw-r--r-- | lang/js/src/index.js | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/lang/js/src/index.js b/lang/js/src/index.js index cf6e2d03..c52460cc 100644 --- a/lang/js/src/index.js +++ b/lang/js/src/index.js @@ -27,9 +27,11 @@ import { gpgme_error } from './Errors'; import { Connection } from './Connection'; /** - * Initializes gpgme.js by testing the nativeMessaging connection once. - * @returns {Promise<GpgME> | GPGME_Error} - * + * Main entry point for gpgme.js. It initializes by testing the nativeMessaging + * connection once, and then offers the available functions as method of the + * response object. + * An unsuccessful attempt will reject as a GPGME_Error. + * @returns {Promise<GpgME>} * @async */ function init (){ |