diff --git a/src/components/MessagesList/MessagesList.vue b/src/components/MessagesList/MessagesList.vue index 94db9a130..df6dbdbb1 100644 --- a/src/components/MessagesList/MessagesList.vue +++ b/src/components/MessagesList/MessagesList.vue @@ -793,7 +793,7 @@ export default { * @param {string} messageId message id * @param {boolean} smooth true to smooth scroll, false to jump directly * @param {boolean} highlightAnimation true to highlight and set focus to the message - * @return {bool} true if element was found, false otherwise + * @return {boolean} true if element was found, false otherwise */ focusMessage(messageId, smooth = true, highlightAnimation = true) { const element = document.getElementById(`message_${messageId}`) diff --git a/src/components/NewMessageForm/NewMessageForm.vue b/src/components/NewMessageForm/NewMessageForm.vue index 5e89d01e4..03a90b0e1 100644 --- a/src/components/NewMessageForm/NewMessageForm.vue +++ b/src/components/NewMessageForm/NewMessageForm.vue @@ -447,8 +447,8 @@ export default { * Handles file upload * * @param {File[] | FileList} files pasted files list - * @param {bool} rename whether to rename the files - * @param {bool} isVoiceMessage indicates whether the file is a vooicemessage + * @param {boolean} rename whether to rename the files + * @param {boolean} isVoiceMessage indicates whether the file is a vooicemessage */ async handleFiles(files, rename = false, isVoiceMessage) { // Create a unique id for the upload operation diff --git a/src/services/messagesService.js b/src/services/messagesService.js index cfbe4c28a..36ef166d7 100644 --- a/src/services/messagesService.js +++ b/src/services/messagesService.js @@ -30,9 +30,9 @@ import Hex from 'crypto-js/enc-hex' * specified with its token. * * @param {string} token the conversation token; - * @param {object} options options; * @param {string} lastKnownMessageId last known message id; - * @param {bool} includeLastKnown whether to include the last known message in the response; + * @param {boolean} includeLastKnown whether to include the last known message in the response; + * @param {object} options options; */ const fetchMessages = async function({ token, lastKnownMessageId, includeLastKnown }, options) { return axios.get(generateOcsUrl('apps/spreed/api/v1/chat/{token}', { token }), Object.assign(options, { diff --git a/src/services/participantsService.js b/src/services/participantsService.js index df0d22022..a732ce439 100644 --- a/src/services/participantsService.js +++ b/src/services/participantsService.js @@ -35,7 +35,7 @@ import { * * @param {string} token The conversation token; * @param {options} options request options; - * @param {bool} forceJoin whether to force join; + * @param {boolean} forceJoin whether to force join; */ const joinConversation = async ({ token, forceJoin = false }, options) => { const response = await axios.post(generateOcsUrl('apps/spreed/api/v4/room/{token}/participants/active', { token }), { diff --git a/src/store/callViewStore.js b/src/store/callViewStore.js index 4805d068d..05d9b311b 100644 --- a/src/store/callViewStore.js +++ b/src/store/callViewStore.js @@ -140,9 +140,9 @@ const actions = { * If clearLast is false, also remembers it in separate properties. * * @param {object} context default store context; - * @param {bool} isGrid=null true for enabled grid mode, false for speaker view; - * @param {bool} isStripeOpen=null true for visible stripel mode, false for speaker view; - * @param {bool} clearLast=true set to false to not reset last temporary remembered state; + * @param {boolean|null} isGrid true for enabled grid mode, false for speaker view; + * @param {boolean|null} isStripeOpen true for visible stripel mode, false for speaker view; + * @param {boolean} clearLast set to false to not reset last temporary remembered state; */ setCallViewMode(context, { isGrid = null, isStripeOpen = null, clearLast = true }) { if (clearLast) { diff --git a/src/store/fileUploadStore.js b/src/store/fileUploadStore.js index a935b9d6b..93ec22a6b 100644 --- a/src/store/fileUploadStore.js +++ b/src/store/fileUploadStore.js @@ -194,7 +194,7 @@ const actions = { * @param {object} files the files to be processed * @param {string} token the conversation's token where to share the files * @param {number} uploadId a unique id for the upload operation indexing - * @param {bool} rename whether to rename the files (usually after pasting) + * @param {boolean} rename whether to rename the files (usually after pasting) */ async initialiseUpload({ commit, dispatch }, { uploadId, token, files, rename = false, isVoiceMessage }) { // Set last upload id diff --git a/src/store/messagesStore.js b/src/store/messagesStore.js index 7fe426a49..5c3be0c55 100644 --- a/src/store/messagesStore.js +++ b/src/store/messagesStore.js @@ -42,7 +42,7 @@ import { * * @param {object} context store context * @param {object} message message object - * @return {bool} true if the message contains a mention to self or all, + * @return {boolean} true if the message contains a mention to self or all, * false otherwise */ function hasMentionToSelf(context, message) { @@ -118,7 +118,7 @@ const getters = { * * @param {object} state the state object. * @param {object} getters the getters object. - * @return {bool} true if more messages exist that needs loading, false otherwise + * @return {boolean} true if more messages exist that needs loading, false otherwise */ hasMoreMessagesToLoad: (state, getters) => (token) => { const conversation = getters.conversation(token) @@ -547,7 +547,7 @@ const actions = { * @param {object} context default store context; * @param token.token * @param {object} token the token of the conversation to be updated; - * @param {bool} updateVisually whether to also clear the marker visually in the UI; + * @param {boolean} updateVisually whether to also clear the marker visually in the UI; * @param token.updateVisually */ async clearLastReadMessage(context, { token, updateVisually = false }) { @@ -568,7 +568,7 @@ const actions = { * @param token.token * @param {object} token the token of the conversation to be updated; * @param {number} id the id of the message on which to set the read marker; - * @param {bool} updateVisually whether to also update the marker visually in the UI; + * @param {boolean} updateVisually whether to also update the marker visually in the UI; * @param token.id * @param token.updateVisually */ @@ -602,7 +602,7 @@ const actions = { * @param {string} token the conversation token; * @param {object} requestOptions request options; * @param {string} lastKnownMessageId last known message id; - * @param {bool} includeLastKnown whether to include the last known message in the response; + * @param {boolean} includeLastKnown whether to include the last known message in the response; */ async fetchMessages(context, { token, lastKnownMessageId, includeLastKnown, requestOptions }) { context.dispatch('cancelFetchMessages') @@ -663,7 +663,7 @@ const actions = { * Cancels a previously running "fetchMessages" action if applicable. * * @param {object} context default store context; - * @return {bool} true if a request got cancelled, false otherwise + * @return {boolean} true if a request got cancelled, false otherwise */ cancelFetchMessages(context) { if (context.state.cancelFetchMessages) { @@ -772,7 +772,7 @@ const actions = { * * @param {object} context default store context; * @param {string} requestId request id - * @return {bool} true if a request got cancelled, false otherwise + * @return {boolean} true if a request got cancelled, false otherwise */ cancelLookForNewMessages(context, { requestId }) { if (context.state.cancelLookForNewMessages[requestId]) { @@ -886,7 +886,7 @@ const actions = { * * @param {object} context default store context; * @param {string} messageId the message id for which to cancel; - * @return {bool} true if a request got cancelled, false otherwise + * @return {boolean} true if a request got cancelled, false otherwise */ cancelPostNewMessage(context, { messageId }) { if (context.state.cancelPostNewMessage[messageId]) { diff --git a/src/utils/webrtc/models/LocalMediaModel.js b/src/utils/webrtc/models/LocalMediaModel.js index 962e80940..9db015ec2 100644 --- a/src/utils/webrtc/models/LocalMediaModel.js +++ b/src/utils/webrtc/models/LocalMediaModel.js @@ -442,7 +442,7 @@ LocalMediaModel.prototype = { /** * Toggles hand raised mode for the local participant * - * @param {bool} raised true for raised, false for lowered + * @param {boolean} raised true for raised, false for lowered */ toggleHandRaised(raised) { if (!this._webRtc) { diff --git a/src/utils/webrtc/simplewebrtc/localmedia.js b/src/utils/webrtc/simplewebrtc/localmedia.js index 5a293fa7a..9192e8ceb 100644 --- a/src/utils/webrtc/simplewebrtc/localmedia.js +++ b/src/utils/webrtc/simplewebrtc/localmedia.js @@ -136,7 +136,7 @@ const cloneLinkedStream = function(stream) { * no media was available when started. An active local media will automatically * react to changes in the selected media devices. * - * @return {bool} true if the local media is active, false otherwise + * @return {boolean} true if the local media is active, false otherwise */ LocalMedia.prototype.isLocalMediaActive = function() { return this._localMediaActive