Add documentation to getWebCrypto

This commit is contained in:
Tankred Hase 2014-10-01 11:23:34 +02:00
parent 72cb1cfc49
commit 5d07ee1eb1

View File

@ -307,6 +307,11 @@ module.exports = {
return "unknown";
},
/**
* Get native Web Cryptography api. The default configuration is to use
* the api when available. But it can also be deactivated with config.useWebCrypto
* @return {Object} The SubtleCrypto api or 'undefined'
*/
getWebCrypto: function() {
if (config.useWebCrypto === false) {
// make web crypto optional