diff options
author | Marius David Wieschollek <passwords.public@mdns.eu> | 2020-01-17 22:00:50 +0300 |
---|---|---|
committer | Marius David Wieschollek <passwords.public@mdns.eu> | 2020-01-17 22:00:50 +0300 |
commit | 61a292447ae3f1646db2f449ae85ba89a5a917b6 (patch) | |
tree | 24bc7151b1600b960c1fd7f8ffc4366f5aa50630 /src | |
parent | f63ab1fbbe9ddaf838b7111effc027227cd8a79d (diff) |
Update incorrect type hints
Signed-off-by: Marius David Wieschollek <passwords.public@mdns.eu>
Diffstat (limited to 'src')
-rw-r--r-- | src/Authorization/SessionAuthorization.js | 12 | ||||
-rw-r--r-- | src/Authorization/Token/AbstractToken.js | 20 | ||||
-rw-r--r-- | src/Authorization/Token/RequestToken.js | 2 | ||||
-rw-r--r-- | src/Authorization/Token/UserToken.js | 4 | ||||
-rw-r--r-- | src/Classes/Encryption.js | 14 | ||||
-rw-r--r-- | src/Classes/EnhancedApi.js | 4 | ||||
-rw-r--r-- | src/Classes/SimpleApi.js | 2 | ||||
-rw-r--r-- | src/Encryption/CSEv1Encryption.js | 12 | ||||
-rw-r--r-- | src/Encryption/Keychain/CSEv1Keychain.js | 10 | ||||
-rw-r--r-- | src/Exception/EncryptionTypeNotSupported.js | 8 | ||||
-rw-r--r-- | src/Network/ApiRequest.js | 10 | ||||
-rw-r--r-- | src/State/BooleanState.js | 6 |
12 files changed, 52 insertions, 52 deletions
diff --git a/src/Authorization/SessionAuthorization.js b/src/Authorization/SessionAuthorization.js index 1b9b853..416a448 100644 --- a/src/Authorization/SessionAuthorization.js +++ b/src/Authorization/SessionAuthorization.js @@ -38,7 +38,7 @@ export default class SessionAuthorization { /** * - * @return {boolean} + * @return {Boolean} * @deprecated */ hasChallenge() { @@ -47,7 +47,7 @@ export default class SessionAuthorization { /** * - * @return {boolean} + * @return {Boolean} */ requiresChallenge() { return this._challenge !== null; @@ -63,7 +63,7 @@ export default class SessionAuthorization { /** * - * @return {boolean} + * @return {Boolean} */ requiresToken() { return this._tokens.length !== 0; @@ -87,7 +87,7 @@ export default class SessionAuthorization { /** * - * @param {(AbstractToken|string|null)} tokenId + * @param {(AbstractToken|String|null)} tokenId * @return {SessionAuthorization} */ setActiveToken(tokenId) { @@ -110,8 +110,8 @@ export default class SessionAuthorization { /** * - * @param {string} [password] - * @param {string|AbstractToken} [token] + * @param {String} [password] + * @param {(String|AbstractToken)} [token] * @return {Promise<void>} */ async authorize(password, token) { diff --git a/src/Authorization/Token/AbstractToken.js b/src/Authorization/Token/AbstractToken.js index 9e70d43..36d6d24 100644 --- a/src/Authorization/Token/AbstractToken.js +++ b/src/Authorization/Token/AbstractToken.js @@ -3,10 +3,10 @@ export default class AbstractToken { /** * * @param {Api} api - * @param {string} id - * @param {string} label - * @param {string} description - * @param {boolean} request + * @param {String} id + * @param {String} label + * @param {String} description + * @param {Boolean} request */ constructor(api, id, label, description, request) { this._id = id; @@ -19,7 +19,7 @@ export default class AbstractToken { /** * - * @return {string} + * @return {String} */ getType() { return 'abstract-token'; @@ -27,7 +27,7 @@ export default class AbstractToken { /** * - * @return {string} + * @return {String} */ getId() { return this._id; @@ -35,7 +35,7 @@ export default class AbstractToken { /** * - * @return {string} + * @return {String} */ getLabel() { return this._label; @@ -43,7 +43,7 @@ export default class AbstractToken { /** * - * @return {string} + * @return {String} */ getDescription() { return this._description; @@ -51,7 +51,7 @@ export default class AbstractToken { /** * - * @return {boolean} + * @return {Boolean} */ requiresRequest() { return this._request; @@ -59,7 +59,7 @@ export default class AbstractToken { /** * - * @return {(string|null)} + * @return {(String|null)} */ getToken() { return this._token; diff --git a/src/Authorization/Token/RequestToken.js b/src/Authorization/Token/RequestToken.js index c3591ef..8efeebd 100644 --- a/src/Authorization/Token/RequestToken.js +++ b/src/Authorization/Token/RequestToken.js @@ -4,7 +4,7 @@ export default class RequestToken extends AbstractToken { /** * - * @return {string} + * @return {String} */ getType() { return 'request-token'; diff --git a/src/Authorization/Token/UserToken.js b/src/Authorization/Token/UserToken.js index 4cad294..f19c7e3 100644 --- a/src/Authorization/Token/UserToken.js +++ b/src/Authorization/Token/UserToken.js @@ -4,7 +4,7 @@ export default class UserToken extends AbstractToken { /** * - * @return {string} + * @return {String} */ getType() { return 'user-token'; @@ -12,7 +12,7 @@ export default class UserToken extends AbstractToken { /** * - * @param {string} value + * @param {String} value * @return {UserToken} */ setToken(value) { diff --git a/src/Classes/Encryption.js b/src/Classes/Encryption.js index 1454e6a..3e310c7 100644 --- a/src/Classes/Encryption.js +++ b/src/Classes/Encryption.js @@ -17,7 +17,7 @@ export default class Encryption { /** * - * @returns {boolean} + * @returns {Boolean} */ get enabled() { return this._enabled; @@ -25,7 +25,7 @@ export default class Encryption { /** * - * @returns {boolean} + * @returns {Boolean} */ get keys() { return Object.keys(this._keys); @@ -43,7 +43,7 @@ export default class Encryption { /** * Returns true if the user has base64 encoded properties * - * @return {boolean} + * @return {Boolean} */ hasLegacyEncoding() { return this._legacyEncoding; @@ -144,7 +144,7 @@ export default class Encryption { * * @param message * @param key - * @returns {string} + * @returns {String} */ encryptString(message, key) { return sodium.to_hex(this.encrypt(message, key)); @@ -168,7 +168,7 @@ export default class Encryption { * * @param encodedString * @param key - * @returns {string} + * @returns {String} */ decryptString(encodedString, key) { try { @@ -206,7 +206,7 @@ export default class Encryption { * * @param salts * @param password - * @returns {string} + * @returns {String} */ solveChallenge(password, salts) { if(password.length < 12) throw new Error('Password is too short'); @@ -351,7 +351,7 @@ export default class Encryption { /** * Create a uuidv4 * - * @returns {string} + * @returns {String} */ getUuid() { return ([1e7] + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/g, c => diff --git a/src/Classes/EnhancedApi.js b/src/Classes/EnhancedApi.js index 16022d9..bcd8c05 100644 --- a/src/Classes/EnhancedApi.js +++ b/src/Classes/EnhancedApi.js @@ -7,7 +7,7 @@ export default class EnhancedApi extends SimpleApi { /** * Is the user session authorized to make encrypted requests * - * @returns {boolean} + * @returns {Boolean} */ get isAuthorized() { return this._isAuthorized === true; @@ -16,7 +16,7 @@ export default class EnhancedApi extends SimpleApi { /** * Is the encryption active and able to encrypt/decrypt * - * @returns {boolean} + * @returns {Boolean} */ get hasEncryption() { return this.config.encryption.enabled; diff --git a/src/Classes/SimpleApi.js b/src/Classes/SimpleApi.js index aeea663..5fe8598 100644 --- a/src/Classes/SimpleApi.js +++ b/src/Classes/SimpleApi.js @@ -746,7 +746,7 @@ export default class SimpleApi { /** * * @param path - * @returns {string} + * @returns {String} * @private */ _getRequestUrl(path) { diff --git a/src/Encryption/CSEv1Encryption.js b/src/Encryption/CSEv1Encryption.js index 8a7d347..9a04aba 100644 --- a/src/Encryption/CSEv1Encryption.js +++ b/src/Encryption/CSEv1Encryption.js @@ -25,7 +25,7 @@ export default class CSEv1Encryption { * Encrypts an object * * @param {Object} object - * @param {string} type + * @param {String} type * @returns {Object} */ async encrypt(object, type) { @@ -54,7 +54,7 @@ export default class CSEv1Encryption { * Decrypts an object * * @param {Object} object - * @param {string} type + * @param {String} type * @returns {Object} */ async decrypt(object, type) { @@ -80,9 +80,9 @@ export default class CSEv1Encryption { /** * Encrypt the message with the given key and return a hex encoded string * - * @param {string} message + * @param {String} message * @param {Uint8Array} key - * @returns {string} + * @returns {String} * @private */ _encryptString(message, key) { @@ -92,9 +92,9 @@ export default class CSEv1Encryption { /** * Decrypt the hex or base64 encoded message with the given key * - * @param {string} encodedString + * @param {String} encodedString * @param {Uint8Array} key - * @returns {string} + * @returns {String} * @private */ _decryptString(encodedString, key) { diff --git a/src/Encryption/Keychain/CSEv1Keychain.js b/src/Encryption/Keychain/CSEv1Keychain.js index ba3904b..22e6bab 100644 --- a/src/Encryption/Keychain/CSEv1Keychain.js +++ b/src/Encryption/Keychain/CSEv1Keychain.js @@ -40,7 +40,7 @@ export default class CSEv1Keychain { * Get a key by id * * @param id - * @returns {string} + * @returns {String} */ getKey(id) { if(this._keys.hasOwnProperty(id)) { @@ -54,7 +54,7 @@ export default class CSEv1Keychain { /** * Get the current key * - * @returns {string} + * @returns {String} */ getCurrentKey() { return this.getKey(this._current); @@ -63,7 +63,7 @@ export default class CSEv1Keychain { /** * Get the current key * - * @returns {string|null} + * @returns {(String|null)} */ getCurrentKeyId() { return this._current; @@ -72,7 +72,7 @@ export default class CSEv1Keychain { /** * Decrypt the given keychain and apply it * - * @param {string} keychainText + * @param {String} keychainText */ import(keychainText) { let encrypted; @@ -101,7 +101,7 @@ export default class CSEv1Keychain { /** * Export the keychain as encrypted string * - * @returns {string} + * @returns {String} */ export() { let keychain = { diff --git a/src/Exception/EncryptionTypeNotSupported.js b/src/Exception/EncryptionTypeNotSupported.js index b1fefc4..aa1824d 100644 --- a/src/Exception/EncryptionTypeNotSupported.js +++ b/src/Exception/EncryptionTypeNotSupported.js @@ -2,7 +2,7 @@ export default class EncryptionTypeNotSupported extends Error { /** * - * @return {string} + * @return {String} */ get objectId() { return this._objectId; @@ -10,7 +10,7 @@ export default class EncryptionTypeNotSupported extends Error { /** * - * @return {string} + * @return {String} */ get cseType() { return this._cseType; @@ -18,8 +18,8 @@ export default class EncryptionTypeNotSupported extends Error { /** * - * @param {string} objectId - * @param {string} cseType + * @param {String} objectId + * @param {String} cseType */ constructor(objectId, cseType) { super(`The encryption type ${cseType} used for ${objectId} is not supported by this client`); diff --git a/src/Network/ApiRequest.js b/src/Network/ApiRequest.js index 61a4330..9a6af72 100644 --- a/src/Network/ApiRequest.js +++ b/src/Network/ApiRequest.js @@ -5,7 +5,7 @@ export default class ApiRequest { /** * * @param {Api} api - * @param {string} [url=null] + * @param {String} [url=null] * @param {Session} [session=null] */ constructor(api, url = null, session = null) { @@ -20,7 +20,7 @@ export default class ApiRequest { /** * - * @returns {(string|null)} + * @returns {(String|null)} */ getUrl() { return this._url; @@ -57,7 +57,7 @@ export default class ApiRequest { /** * - * @param {string} value + * @param {String} value * @return {ApiRequest} */ setPath(value) { @@ -79,7 +79,7 @@ export default class ApiRequest { /** * - * @param {string} value + * @param {String} value * @return {ApiRequest} */ setUserAgent(value) { @@ -172,7 +172,7 @@ export default class ApiRequest { /** * - * @param {string} url + * @param {String} url * @param {Object} options * @returns {Promise<Response>} * @private diff --git a/src/State/BooleanState.js b/src/State/BooleanState.js index cc9f0dc..c673540 100644 --- a/src/State/BooleanState.js +++ b/src/State/BooleanState.js @@ -136,7 +136,7 @@ export default class BooleanState { /** * - * @returns {boolean} + * @returns {Boolean} */ toJSON() { return this._value; @@ -164,7 +164,7 @@ export default class BooleanState { /** * - * @param {string} event + * @param {String} event * @private */ _notifyEvents(event) { @@ -175,7 +175,7 @@ export default class BooleanState { /** * - * @param {string} event + * @param {String} event * @param {Function} callback * @private */ |