chore(lint) tame the (uppdated) linter

This commit is contained in:
Saúl Ibarra Corretgé 2021-11-04 22:10:43 +01:00 committed by Saúl Ibarra Corretgé
parent 0aba61d5c6
commit 162a67fe8b
385 changed files with 933 additions and 900 deletions

View File

@ -13,3 +13,6 @@ load-test/*
# not seem to be a reason why we will want to risk being inconsistent with our
# remaining JavaScript source code.
!.eslintrc.js
# Not worth it.
actionTypes.js

View File

@ -760,7 +760,7 @@ export default {
// XXX The API will take care of disconnecting from the XMPP
// server (and, thus, leaving the room) on unload.
return new Promise((resolve, reject) => {
(new ConferenceConnector(resolve, reject)).connect();
new ConferenceConnector(resolve, reject).connect();
});
},

View File

@ -12,6 +12,6 @@ import { parseURLParams } from '../../react/features/base/util/parseURLParams';
export const API_ID = parseURLParams(window.location).jitsi_meet_external_api_id;
/**
* The payload name for the datachannel/endpoint text message event
* The payload name for the datachannel/endpoint text message event.
*/
export const ENDPOINT_TEXT_MESSAGE_NAME = 'endpoint-text-message';

View File

@ -24,7 +24,7 @@ const ALWAYS_ON_TOP_FILENAMES = [
/**
* Maps the names of the commands expected by the API with the name of the
* commands expected by jitsi-meet
* commands expected by jitsi-meet.
*/
const commands = {
answerKnockingParticipant: 'answer-knocking-participant',
@ -75,7 +75,7 @@ const commands = {
/**
* Maps the names of the events expected by the API with the name of the
* events expected by jitsi-meet
* events expected by jitsi-meet.
*/
const events = {
'avatar-changed': 'avatarChanged',
@ -129,7 +129,8 @@ const events = {
};
/**
* Last id of api object
* Last id of api object.
*
* @type {number}
*/
let id = 0;
@ -387,7 +388,7 @@ export default class JitsiMeetExternalAPI extends EventEmitter {
}
return ALWAYS_ON_TOP_FILENAMES.map(
filename => (new URL(filename, baseURL)).href
filename => new URL(filename, baseURL).href
);
}

12
package-lock.json generated
View File

@ -60,7 +60,7 @@
"jquery-i18next": "1.2.1",
"js-md5": "0.6.1",
"jwt-decode": "2.2.0",
"lib-jitsi-meet": "github:jitsi/lib-jitsi-meet#e6b330186fbf667d1f8a7fa48410772cd2526e9d",
"lib-jitsi-meet": "github:jitsi/lib-jitsi-meet#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"libflacjs": "github:mmig/libflac.js#93d37e7f811f01cf7d8b6a603e38bd3c3810907d",
"lodash": "4.17.21",
"moment": "2.29.1",
@ -12405,8 +12405,8 @@
},
"node_modules/lib-jitsi-meet": {
"version": "0.0.0",
"resolved": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#e6b330186fbf667d1f8a7fa48410772cd2526e9d",
"integrity": "sha512-9dGkPk5cvhIeo9USMH9vqXk0dgbfF5rmhFFu8Zrr0I93HxmHd7hWdnwlTaOuSQc6E0q/NZTOxGn3TStNp5VN7Q==",
"resolved": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"integrity": "sha512-PrmwypA0wTjSXswh29tnNFng505+NhLpvSNhJRa82L+bfhCCAI1c/Z2BaKFUf4FpM7s/fsU4w5yE//WZ6MpNMQ==",
"hasInstallScript": true,
"license": "Apache-2.0",
"dependencies": {
@ -29724,9 +29724,9 @@
}
},
"lib-jitsi-meet": {
"version": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#e6b330186fbf667d1f8a7fa48410772cd2526e9d",
"integrity": "sha512-9dGkPk5cvhIeo9USMH9vqXk0dgbfF5rmhFFu8Zrr0I93HxmHd7hWdnwlTaOuSQc6E0q/NZTOxGn3TStNp5VN7Q==",
"from": "lib-jitsi-meet@github:jitsi/lib-jitsi-meet#e6b330186fbf667d1f8a7fa48410772cd2526e9d",
"version": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"integrity": "sha512-PrmwypA0wTjSXswh29tnNFng505+NhLpvSNhJRa82L+bfhCCAI1c/Z2BaKFUf4FpM7s/fsU4w5yE//WZ6MpNMQ==",
"from": "lib-jitsi-meet@github:jitsi/lib-jitsi-meet#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"requires": {
"@jitsi/js-utils": "2.0.0",
"@jitsi/sdp-interop": "github:jitsi/sdp-interop#4669790bb9020cc8f10c1d1f3823c26b08497547",

View File

@ -5,5 +5,9 @@ module.exports = {
'eslint-config-jitsi/jsdoc',
'eslint-config-jitsi/react',
'.eslintrc-react-native.js'
]
],
'rules': {
// XXX remove this eventually.
'react/jsx-indent-props': 0
}
};

View File

@ -33,7 +33,7 @@ type State = {
* Represents the always on top page.
*
* @class AlwaysOnTop
* @extends Component
* @augments Component
*/
export default class AlwaysOnTop extends Component<*, State> {
_hovered: boolean;

View File

@ -30,7 +30,7 @@ type Props = {
/**
* Represents the toolbar in the Always On Top window.
*
* @extends Component
* @augments Component
*/
export default class Toolbar extends Component<Props> {
/**

View File

@ -2,6 +2,7 @@
* The constant for the event type 'track'.
* TODO: keep these constants in a single place. Can we import them from
* lib-jitsi-meet's AnalyticsEvents somehow?
*
* @type {string}
*/
const TYPE_TRACK = 'track';
@ -10,6 +11,7 @@ const TYPE_TRACK = 'track';
* The constant for the event type 'UI' (User Interaction).
* TODO: keep these constants in a single place. Can we import them from
* lib-jitsi-meet's AnalyticsEvents somehow?
*
* @type {string}
*/
const TYPE_UI = 'ui';

View File

@ -1,5 +1,5 @@
/**
* Abstract implementation of analytics handler
* Abstract implementation of analytics handler.
*/
export default class AbstractHandler {
/**

View File

@ -51,7 +51,7 @@ type Props = AbstractAppProps & {
/**
* Root app {@code Component} on mobile/React Native.
*
* @extends AbstractApp
* @augments AbstractApp
*/
export class App extends AbstractApp {
_init: Promise<*>;

View File

@ -17,7 +17,7 @@ import '../reducers';
/**
* Root app {@code Component} on Web/React.
*
* @extends AbstractApp
* @augments AbstractApp
*/
export class App extends AbstractApp {
/**

View File

@ -29,7 +29,7 @@ type Props = {
/**
* Creates a ReactElement responsible for drawing audio levels.
*
* @extends {Component}
* @augments {Component}
*/
class AudioLevelIndicator extends Component<Props> {
/**

View File

@ -29,7 +29,7 @@ import './styles';
type Props = {
/**
* {@link JitsiConference} that needs authentication - will hold a valid
* {@link JitsiConference} That needs authentication - will hold a valid
* value in XMPP login + guest access mode.
*/
_conference: Object,

View File

@ -21,7 +21,7 @@ import {
type Props = {
/**
* {@link JitsiConference} that needs authentication - will hold a valid
* {@link JitsiConference} That needs authentication - will hold a valid
* value in XMPP login + guest access mode.
*/
_conference: Object,

View File

@ -259,5 +259,5 @@ export default class BaseApp extends Component<*, State> {
*
* @returns {React$Element}
*/
_renderDialogContainer: () => React$Element<*>
_renderDialogContainer: () => React$Element<*>;
}

View File

@ -12,13 +12,6 @@ ReducerRegistry.register('features/base/app', (state = {}, action) => {
if (state.app !== app) {
return {
...state,
/**
* The one and only (i.e. singleton) {@link BaseApp} instance
* which is currently mounted.
*
* @type {BaseApp}
*/
app
};
}

View File

@ -38,12 +38,12 @@ export type Props = {
/**
* Display name of the entity to render an avatar for (if any). This is handy when we need
* an avatar for a non-participasnt entity (e.g. a recent list item).
* an avatar for a non-participasnt entity (e.g. A recent list item).
*/
displayName?: string,
/**
* Whether or not to update the background color of the avatar
* Whether or not to update the background color of the avatar.
*/
dynamicColor?: Boolean,

View File

@ -63,7 +63,7 @@ export default class StatelessAvatar extends AbstractStatelessAvatar<Props> {
);
}
_isIcon: (?string | ?Object) => boolean
_isIcon: (?string | ?Object) => boolean;
/**
* Renders a badge representing the avatar status.

View File

@ -13,7 +13,7 @@ type Props = AbstractProps & {
className?: string,
/**
* The default avatar URL if we want to override the app bundled one (e.g. AlwaysOnTop)
* The default avatar URL if we want to override the app bundled one (e.g. AlwaysOnTop).
*/
defaultAvatar?: string,
@ -157,5 +157,5 @@ export default class StatelessAvatar extends AbstractStatelessAvatar<Props> {
return '';
}
_isIcon: (?string | ?Object) => boolean
_isIcon: (?string | ?Object) => boolean;
}

View File

@ -1,5 +1,7 @@
// @flow
/* eslint-disable react/jsx-no-bind */
import React, { useState } from 'react';
import { Icon, IconCheck, IconCopy } from '../../base/icons';
@ -9,32 +11,32 @@ import { copyText } from '../util';
type Props = {
/**
* Css class to apply on container
* Css class to apply on container.
*/
className: string,
/**
* The displayed text
* The displayed text.
*/
displayedText: string,
/**
* The text that needs to be copied (might differ from the displayedText)
* The text that needs to be copied (might differ from the displayedText).
*/
textToCopy: string,
/**
* The text displayed on mouse hover
* The text displayed on mouse hover.
*/
textOnHover: string,
/**
* The text displayed on copy success
* The text displayed on copy success.
*/
textOnCopySuccess: string,
/**
* The id of the button
* The id of the button.
*/
id?: string,
};

View File

@ -21,7 +21,7 @@ type Props = {
children: string | React$Node,
/**
* Click handler
* Click handler.
*/
onClick: Function,

View File

@ -37,12 +37,12 @@ type Props = {
isDrawerOpen: boolean,
/**
* Target elements against which positioning calculations are made
* Target elements against which positioning calculations are made.
*/
offsetTarget?: HTMLElement,
/**
* Callback for click on an item in the menu
* Callback for click on an item in the menu.
*/
onClick?: Function,
@ -52,12 +52,12 @@ type Props = {
onDrawerClose: Function,
/**
* Callback for the mouse entering the component
* Callback for the mouse entering the component.
*/
onMouseEnter?: Function,
/**
* Callback for the mouse leaving the component
* Callback for the mouse leaving the component.
*/
onMouseLeave: Function
};

View File

@ -54,7 +54,7 @@ type Props = {
actions?: Array<Action>,
/**
* The children of the component
* The children of the component.
*/
children?: React$Node,
};

View File

@ -14,7 +14,7 @@ type Props = {
actions: React$Node,
/**
* Icon to be displayed on the list item. (Avatar for participants)
* Icon to be displayed on the list item. (Avatar for participants).
*/
icon: React$Node,

View File

@ -1,4 +1,4 @@
/**
* Deploy-specific configuration whitelists
* Deploy-specific configuration whitelists.
*/
export default [];

View File

@ -45,7 +45,7 @@ class AlertDialog extends BaseSubmitDialog<Props, *> {
);
}
_renderHTML: string => Object | string
_renderHTML: string => Object | string;
}
export default translate(connect(_abstractMapStateToProps)(AlertDialog));

View File

@ -93,7 +93,7 @@ class BaseDialog<P: Props, S: State> extends AbstractDialog<P, S> {
*
* @returns {ReactElement}
*/
_renderContent: () => Object
_renderContent: () => Object;
/**
* Renders a specific {@code string} which may contain HTML.

View File

@ -21,7 +21,7 @@ type Props = BaseProps & {
}
/**
* Abstract dialog to submit something. E.g. a confirmation or a form.
* Abstract dialog to submit something. E.g. A confirmation or a form.
*/
class BaseSubmitDialog<P: Props, S: *> extends BaseDialog<P, S> {
/**
@ -84,16 +84,16 @@ class BaseSubmitDialog<P: Props, S: *> extends BaseDialog<P, S> {
_onSubmit: () => boolean;
_renderHTML: string => Object | string
_renderHTML: string => Object | string;
/**
/** .
* Renders the actual content of the dialog defining what is about to be
* submitted. E.g. a simple confirmation (text, properly wrapped) or a
* submitted. E.g. A simple confirmation (text, properly wrapped) or a
* complex form.
*
* @returns {Object}
*/
_renderSubmittable: () => Object
_renderSubmittable: () => Object;
}
export default BaseSubmitDialog;

View File

@ -72,7 +72,7 @@ type Props = {
showSlidingView?: boolean,
/**
* The component's external style
* The component's external style.
*/
style: Object
};

View File

@ -101,7 +101,7 @@ class ConfirmDialog extends BaseSubmitDialog<Props, *> {
);
}
_renderHTML: string => Object | string
_renderHTML: string => Object | string;
}
export default translate(connect(_abstractMapStateToProps)(ConfirmDialog));

View File

@ -12,7 +12,7 @@ import AbstractDialogContainer, {
* need a separate container so we can handle multiple dialogs by showing them
* simultaneously or queueing them.
*
* @extends AbstractDialogContainer
* @augments AbstractDialogContainer
*/
class DialogContainer extends AbstractDialogContainer {

View File

@ -34,7 +34,7 @@ type Props = BaseProps & {
initialValue?: ?string,
/**
* A message key to be shown for the user (e.g. an error that is defined after submitting the form).
* A message key to be shown for the user (e.g. An error that is defined after submitting the form).
*/
messageKey?: string,

View File

@ -27,7 +27,7 @@ export type Props = {
/**
* Abstract React {@code Component} for tabs of the DialogWithTabs component.
*
* @extends Component
* @augments Component
*/
class AbstractDialogTab<P: Props, S: *> extends Component<P, S> {
/**

View File

@ -34,7 +34,7 @@ type Props = AbstractDialogProps & {
* - 'small' (400px), 'medium' (600px), 'large' (800px),
* 'x-large' (968px)
* - integer value for pixel width
* - string value for percentage
* - string value for percentage.
*/
width: string
};

View File

@ -10,7 +10,7 @@ import AbstractDialogContainer, {
* Implements a DialogContainer responsible for showing all dialogs. Necessary
* for supporting @atlaskit's modal animations.
*
* @extends AbstractDialogContainer
* @augments AbstractDialogContainer
*/
class DialogContainer extends AbstractDialogContainer {
/**

View File

@ -77,7 +77,7 @@ type State = {
/**
* A React {@code Component} for displaying a dialog with tabs.
*
* @extends Component
* @augments Component
*/
class DialogWithTabs extends Component<Props, State> {
/**

View File

@ -77,11 +77,10 @@ const styles = theme => {
/**
* A default header for modal-dialog components
* A default header for modal-dialog components.
*
* @export
* @class ModalHeader
* @extends {React.Component<Props>}
* @augments {React.Component<Props>}
*/
class ModalHeader extends React.Component<Props> {
static defaultProps = {

View File

@ -14,12 +14,14 @@ import ModalHeader from './ModalHeader';
/**
* The ID to be used for the cancel button if enabled.
*
* @type {string}
*/
const CANCEL_BUTTON_ID = 'modal-dialog-cancel-button';
/**
* The ID to be used for the ok button if enabled.
*
* @type {string}
*/
const OK_BUTTON_ID = 'modal-dialog-ok-button';
@ -102,7 +104,7 @@ type Props = DialogProps & {
* - 'small' (400px), 'medium' (600px), 'large' (800px),
* 'x-large' (968px)
* - integer value for pixel width
* - string value for percentage
* - string value for percentage.
*/
width: string
};
@ -131,7 +133,7 @@ class StatelessDialog extends Component<Props> {
/**
* The functional component to be used for rendering the modal footer.
*/
_Footer: ?Function
_Footer: ?Function;
_dialogElement: ?HTMLElement;

View File

@ -1,3 +1,5 @@
// @flow
import {
Dialog,
FillScreen,
@ -10,7 +12,11 @@ import { N0, DN50 } from '@atlaskit/theme/colors';
import { themed } from '@atlaskit/theme/components';
import React from 'react';
const ThemedDialog = props => {
type Props = {
isChromeless: boolean
}
const ThemedDialog = (props: Props) => {
const style = { backgroundColor: props.isChromeless ? 'transparent' : themed({ light: N0,
dark: DN50 })({ theme: { mode: 'dark' } }) };

View File

@ -52,7 +52,7 @@ export type DialogProps = {
/**
* The string to use as a title instead of {@code titleKey}. If a truthy
* value is specified, it takes precedence over {@code titleKey} i.e.
* the latter is unused.
* The latter is unused.
*/
titleString: ?string
};

View File

@ -9,7 +9,7 @@ export const ADD_PEOPLE_ENABLED = 'add-people.enabled';
/**
* Flag indicating if the SDK should not require the audio focus.
* Used by apps that do not use Jitsi audio.
* Default: disabled (false)
* Default: disabled (false).
*/
export const AUDIO_FOCUS_DISABLED = 'audio-focus.disabled';
@ -181,13 +181,13 @@ export const RESOLUTION = 'resolution';
/**
* Flag indicating if the security options button should be enabled.
* Default: enabled (true)
* Default: enabled (true).
*/
export const SECURITY_OPTIONS_ENABLED = 'security-options.enabled';
/**
* Flag indicating if server URL change is enabled.
* Default: enabled (true)
* Default: enabled (true).
*/
export const SERVER_URL_CHANGE_ENABLED = 'server-url-change.enabled';

View File

@ -23,7 +23,7 @@ type Props = {
id?: string,
/**
* Id of the icon container
* Id of the icon container.
*/
containerId?: string,
@ -48,57 +48,57 @@ type Props = {
style?: Object,
/**
* aria disabled flag for the Icon.
* Aria disabled flag for the Icon.
*/
ariaDisabled?: boolean,
/**
* aria label for the Icon.
* Aria label for the Icon.
*/
ariaLabel?: string,
/**
* whether the element has a popup
* Whether the element has a popup.
*/
ariaHasPopup?: boolean,
/**
* whether the element has a pressed
* Whether the element has a pressed.
*/
ariaPressed?: boolean,
/**
* id of description label
* Id of description label.
*/
ariaDescribedBy?: string,
/**
* whether the element popup is expanded
* Whether the element popup is expanded.
*/
ariaExpanded?: boolean,
/**
* The id of the element this button icon controls
* The id of the element this button icon controls.
*/
ariaControls?: string,
/**
* tabIndex for the Icon.
* TabIndex for the Icon.
*/
tabIndex?: number,
/**
* role for the Icon.
* Role for the Icon.
*/
role?: string,
/**
* keypress handler.
* Keypress handler.
*/
onKeyPress?: Function,
/**
* keydown handler.
* Keydown handler.
*/
onKeyDown?: Function
}

View File

@ -79,9 +79,9 @@ export default class ExpandedLabel<P: Props> extends Component<P, State> {
*
* @returns {string}
*/
_getLabel: () => string
_getLabel: () => string;
_getColor: () => string
_getColor: () => string;
/**
* Defines the color of the expanded label. This function returns a default

View File

@ -24,8 +24,8 @@ type Props = AbstractProps & {
/**
* Status of the label. This prop adds some additional styles based on its
* value. E.g. if status = off, it will render the label symbolising that
* the thing it displays (e.g. recording) is off.
* value. E.g. If status = off, it will render the label symbolising that
* the thing it displays (e.g. Recording) is off.
*/
status: ('in_progress' | 'off' | 'on'),

View File

@ -89,7 +89,7 @@ const styles = theme => {
/**
* React Component for showing short text in a circle.
*
* @extends Component
* @augments Component
*/
class Label extends AbstractLabel<Props, *> {
/**

View File

@ -10,6 +10,7 @@ export default class JitsiMeetInMemoryLogStorage {
constructor() {
/**
* Array of the log entries to keep.
*
* @type {array}
*/
this.logs = [];

View File

@ -15,6 +15,7 @@ export default class JitsiMeetLogStorage {
constructor(getState) {
/**
* Counts each log entry, increases on every batch log entry stored.
*
* @type {number}
*/
this.counter = 1;

View File

@ -17,7 +17,7 @@ export type AudioElement = {
};
/**
* {@code AbstractAudio} component's property types.
* {@code AbstractAudio} Component's property types.
*/
type Props = {

View File

@ -12,7 +12,7 @@ import styles from './styles';
/**
* Component that renders video element for a specified video track.
*
* @extends AbstractVideoTrack
* @augments AbstractVideoTrack
*/
class VideoTrack extends AbstractVideoTrack<Props> {
/**

View File

@ -272,7 +272,7 @@ class VideoTransform extends Component<Props, State> {
};
}
_didMove: Object => boolean
_didMove: Object => boolean;
/**
* Determines if there was large enough movement to be handled.
@ -315,7 +315,7 @@ class VideoTransform extends Component<Props, State> {
return Math.sqrt(Math.pow(dx, 2) + Math.pow(dy, 2));
}
_getTouchPosition: Object => Object
_getTouchPosition: Object => Object;
/**
* Calculates the position of the touch event.
@ -331,7 +331,7 @@ class VideoTransform extends Component<Props, State> {
};
}
_getTransformStyle: () => Object
_getTransformStyle: () => Object;
/**
* Generates a transform style object to be used on the component.
@ -460,7 +460,7 @@ class VideoTransform extends Component<Props, State> {
}
}
_onGesture: (string, ?Object | number) => void
_onGesture: (string, ?Object | number) => void;
/**
* Handles gestures and converts them to transforms.
@ -515,7 +515,7 @@ class VideoTransform extends Component<Props, State> {
this.lastTap = 0;
}
_onLayout: Object => void
_onLayout: Object => void;
/**
* Callback for the onLayout of the component.
@ -535,7 +535,7 @@ class VideoTransform extends Component<Props, State> {
});
}
_onMoveShouldSetPanResponder: (Object, Object) => boolean
_onMoveShouldSetPanResponder: (Object, Object) => boolean;
/**
* Function to decide whether the responder should respond to a move event.
@ -551,7 +551,7 @@ class VideoTransform extends Component<Props, State> {
|| gestureState.numberActiveTouches === 2);
}
_onPanResponderGrant: (Object, Object) => void
_onPanResponderGrant: (Object, Object) => void;
/**
* Calculates the initial touch distance.
@ -571,7 +571,7 @@ class VideoTransform extends Component<Props, State> {
}
}
_onPanResponderMove: (Object, Object) => void
_onPanResponderMove: (Object, Object) => void;
/**
* Handles the PanResponder move (touch move) event.
@ -615,7 +615,7 @@ class VideoTransform extends Component<Props, State> {
}
}
_onPanResponderRelease: () => void
_onPanResponderRelease: () => void;
/**
* Handles the PanResponder gesture end event.
@ -631,7 +631,7 @@ class VideoTransform extends Component<Props, State> {
delete this.initialPosition;
}
_onStartShouldSetPanResponder: () => boolean
_onStartShouldSetPanResponder: () => boolean;
/**
* Function to decide whether the responder should respond to a start

View File

@ -46,82 +46,82 @@ type Props = {
eventHandlers?: {|
/**
* onAbort event handler.
* OnAbort event handler.
*/
onAbort?: ?Function,
/**
* onCanPlay event handler.
* OnCanPlay event handler.
*/
onCanPlay?: ?Function,
/**
* onCanPlayThrough event handler.
* OnCanPlayThrough event handler.
*/
onCanPlayThrough?: ?Function,
/**
* onEmptied event handler.
* OnEmptied event handler.
*/
onEmptied?: ?Function,
/**
* onEnded event handler.
* OnEnded event handler.
*/
onEnded?: ?Function,
/**
* onError event handler.
* OnError event handler.
*/
onError?: ?Function,
/**
* onLoadedData event handler.
* OnLoadedData event handler.
*/
onLoadedData?: ?Function,
/**
* onLoadedMetadata event handler.
* OnLoadedMetadata event handler.
*/
onLoadedMetadata?: ?Function,
/**
* onLoadStart event handler.
* OnLoadStart event handler.
*/
onLoadStart?: ?Function,
/**
* onPause event handler.
* OnPause event handler.
*/
onPause?: ?Function,
/**
* onPlay event handler.
* OnPlay event handler.
*/
onPlay?: ?Function,
/**
* onPlaying event handler.
* OnPlaying event handler.
*/
onPlaying?: ?Function,
/**
* onRateChange event handler.
* OnRateChange event handler.
*/
onRateChange?: ?Function,
/**
* onStalled event handler.
* OnStalled event handler.
*/
onStalled?: ?Function,
/**
* onSuspend event handler.
* OnSuspend event handler.
*/
onSuspend?: ?Function,
/**
* onWaiting event handler.
* OnWaiting event handler.
*/
onWaiting?: ?Function
|},
@ -140,7 +140,7 @@ type Props = {
/**
* Component that renders a video element for a passed in video track.
*
* @extends Component
* @augments Component
*/
class Video extends Component<Props> {
_videoElement: ?Object;

View File

@ -37,82 +37,82 @@ type Props = AbstractVideoTrackProps & {
eventHandlers?: {|
/**
* onAbort event handler.
* OnAbort event handler.
*/
onAbort?: ?Function,
/**
* onCanPlay event handler.
* OnCanPlay event handler.
*/
onCanPlay?: ?Function,
/**
* onCanPlayThrough event handler.
* OnCanPlayThrough event handler.
*/
onCanPlayThrough?: ?Function,
/**
* onEmptied event handler.
* OnEmptied event handler.
*/
onEmptied?: ?Function,
/**
* onEnded event handler.
* OnEnded event handler.
*/
onEnded?: ?Function,
/**
* onError event handler.
* OnError event handler.
*/
onError?: ?Function,
/**
* onLoadedData event handler.
* OnLoadedData event handler.
*/
onLoadedData?: ?Function,
/**
* onLoadedMetadata event handler.
* OnLoadedMetadata event handler.
*/
onLoadedMetadata?: ?Function,
/**
* onLoadStart event handler.
* OnLoadStart event handler.
*/
onLoadStart?: ?Function,
/**
* onPause event handler.
* OnPause event handler.
*/
onPause?: ?Function,
/**
* onPlay event handler.
* OnPlay event handler.
*/
onPlay?: ?Function,
/**
* onPlaying event handler.
* OnPlaying event handler.
*/
onPlaying?: ?Function,
/**
* onRateChange event handler.
* OnRateChange event handler.
*/
onRateChange?: ?Function,
/**
* onStalled event handler.
* OnStalled event handler.
*/
onStalled?: ?Function,
/**
* onSuspend event handler.
* OnSuspend event handler.
*/
onSuspend?: ?Function,
/**
* onWaiting event handler.
* OnWaiting event handler.
*/
onWaiting?: ?Function,
|},
@ -132,7 +132,7 @@ type Props = AbstractVideoTrackProps & {
* Component that renders a video element for a passed in video track and
* notifies the store when the video has started playing.
*
* @extends AbstractVideoTrack
* @augments AbstractVideoTrack
*/
class VideoTrack extends AbstractVideoTrack<Props> {
/**

View File

@ -106,7 +106,7 @@ type Props = {
* The test hint id which can be used to locate the {@code ParticipantView}
* on the jitsi-meet-torture side. If not provided, the
* {@code participantId} with the following format will be used:
* {@code `org.jitsi.meet.Participant#${participantId}`}
* {@code `org.jitsi.meet.Participant#${participantId}`}.
*/
testHintId: ?string,
@ -133,7 +133,7 @@ type Props = {
* Implements a React Component which depicts a specific participant's avatar
* and video.
*
* @extends Component
* @augments Component
*/
class ParticipantView extends Component<Props> {

View File

@ -37,7 +37,7 @@ export default {
},
/**
* {@code ParticipantView} style.
* {@code ParticipantView} Style.
*/
participantView: {
alignItems: 'stretch',

View File

@ -47,6 +47,7 @@ export const MAX_DISPLAY_NAME_LENGTH = 50;
/**
* The identifier of the sound to be played when new remote participant joins
* the room.
*
* @type {string}
*/
export const PARTICIPANT_JOINED_SOUND_ID = 'PARTICIPANT_JOINED_SOUND';
@ -54,6 +55,7 @@ export const PARTICIPANT_JOINED_SOUND_ID = 'PARTICIPANT_JOINED_SOUND';
/**
* The identifier of the sound to be played when remote participant leaves
* the room.
*
* @type {string}
*/
export const PARTICIPANT_LEFT_SOUND_ID = 'PARTICIPANT_LEFT_SOUND';

View File

@ -20,6 +20,7 @@ declare var interfaceConfig: Object;
/**
* Participant object.
*
* @typedef {Object} Participant
* @property {string} id - Participant ID.
* @property {string} name - Participant name.

View File

@ -86,7 +86,7 @@ type State = {
* Implements a React {@code Component} for showing an {@code InlineDialog} on
* mouseenter of the trigger and contents, and hiding the dialog on mouseleave.
*
* @extends Component
* @augments Component
*/
class Popover extends Component<Props, State> {
/**

View File

@ -53,27 +53,27 @@ type Props = {
onOptionsClick?: Function,
/**
* to navigate with the keyboard.
* To navigate with the keyboard.
*/
tabIndex?: number,
/**
* to give a role to the icon.
* To give a role to the icon.
*/
role?: string,
/**
* to give a aria-pressed to the icon.
* To give a aria-pressed to the icon.
*/
ariaPressed?: boolean,
/**
* The Label of the current element
* The Label of the current element.
*/
ariaLabel?: string,
/**
* The Label of the child element
* The Label of the child element.
*/
ariaDropDownLabel?: string
};

View File

@ -42,7 +42,7 @@ type Props = {
readOnly?: boolean,
/**
* The field type (e.g. text, password...etc).
* The field type (e.g. Text, password...etc).
*/
type: string,

View File

@ -38,12 +38,12 @@ type Props = {
name?: string,
/**
* Indicates whether the copy url button should be shown
* Indicates whether the copy url button should be shown.
*/
showCopyUrlButton: boolean,
/**
* Indicates whether the device status should be shown
* Indicates whether the device status should be shown.
*/
showDeviceStatus: boolean,

View File

@ -12,7 +12,7 @@ import { getLocalVideoTrack } from '../../../tracks';
export type Props = {
/**
* Local participant id
* Local participant id.
*/
_participantId: string,

View File

@ -115,10 +115,8 @@ function _getLevel(thresholds, value, descending = true) {
/**
* Returns the connection details from the test results.
*
* @param {{
* fractionalLoss: number,
* throughput: number
* }} testResults - The state of the app.
* @param {number} testResults.fractionalLoss - Factional loss.
* @param {number} testResults.throughput - Throughput.
*
* @returns {{
* connectionType: string,

View File

@ -13,7 +13,7 @@ export type Item = {
avatar: ?string,
/**
* the color base of the avatar
* The color base of the avatar.
*/
colorBase: string,
@ -28,46 +28,46 @@ export type Item = {
id: Object | string,
/**
* Item title
* Item title.
*/
title: string,
/**
* Item url
* Item url.
*/
url: string,
/**
* lines[0] - date
* Lines[0] - date
* lines[1] - duration
* lines[2] - server name
* lines[2] - server name.
*/
lines: Array<string>
}
/**
* web implementation of section data for NavigateSectionList
* Web implementation of section data for NavigateSectionList.
*/
export type Section = {
/**
* section title
* Section title.
*/
title: string,
/**
* unique key for the section
* Unique key for the section.
*/
key?: string,
/**
* Array of items in the section
* Array of items in the section.
*/
data: $ReadOnlyArray<Item>,
/**
* Optional properties added only to fix some flow errors thrown by React
* SectionList
* SectionList.
*/
ItemSeparatorComponent?: ?ComponentType<any>,
@ -78,12 +78,12 @@ export type Section = {
}
/**
* native implementation of section data for NavigateSectionList
* Native implementation of section data for NavigateSectionList.
*
* When react-native's SectionList component parses through an array of sections
* it passes the section nested within the section property of another object
* to the renderSection method (on web for our own implementation of SectionList
* this nesting is not implemented as there is no need for nesting)
* this nesting is not implemented as there is no need for nesting).
*/
export type SetionListSection = {
section: Section

View File

@ -5,7 +5,7 @@ import React, { Component } from 'react';
import { getFixedPlatformStyle } from '../../styles';
/**
* {@code AbstractContainer} component's property types.
* {@code AbstractContainer} Component's property types.
*/
export type Props = {
@ -69,7 +69,7 @@ export type Props = {
* Abstract (base) class for container of React {@link Component} children with
* a style.
*
* @extends Component
* @augments Component
*/
export default class AbstractContainer<P: Props> extends Component<P> {
/**

View File

@ -47,7 +47,7 @@ type Props = {
renderListEmptyComponent: Function,
/**
* An array of sections
* An array of sections.
*/
sections: Array<Section>
};

View File

@ -43,7 +43,7 @@ type Props = {
children?: React$Node,
/**
* item containing data to be rendered
* Item containing data to be rendered.
*/
item: Item,

View File

@ -8,7 +8,7 @@ import { Icon, IconArrowBack } from '../../../icons';
import { connect } from '../../../redux';
/**
* The type of the React {@code Component} props of {@link BackButton}
* The type of the React {@code Component} props of {@link BackButton}.
*/
type Props = {

View File

@ -16,7 +16,7 @@ type Props = {
onValueChange: Function,
/**
* The component's external style
* The component's external style.
*/
style: Object
};

View File

@ -22,7 +22,7 @@ type Props = AbstractProps & {
/**
* Represents a container of React Native/mobile {@link Component} children.
*
* @extends AbstractContainer
* @augments AbstractContainer
*/
export default class Container<P: Props> extends AbstractContainer<P> {
/**

View File

@ -8,7 +8,7 @@ import { translate } from '../../../i18n';
import { connect } from '../../../redux';
/**
* The type of the React {@code Component} props of {@link ForwardButton}
* The type of the React {@code Component} props of {@link ForwardButton}.
*/
type Props = {

View File

@ -17,7 +17,7 @@ const STATUSBAR_DARK = 'dark-content';
const STATUSBAR_LIGHT = 'light-content';
/**
* The type of the React {@code Component} props of {@link Header}
* The type of the React {@code Component} props of {@link Header}.
*/
type Props = {
@ -27,7 +27,7 @@ type Props = {
children: Node,
/**
* The component's external style
* The component's external style.
*/
style: Object,

View File

@ -8,7 +8,7 @@ import { translate } from '../../../i18n';
import { connect } from '../../../redux';
/**
* The type of the React {@code Component} props of {@link HeaderLabel}
* The type of the React {@code Component} props of {@link HeaderLabel}.
*/
type Props = {

View File

@ -23,7 +23,7 @@ type Props = {
forwardLabelKey: ?string,
/**
* The i18n key of the header label (title)
* The i18n key of the header label (title).
*/
headerLabelKey: ?string,

View File

@ -14,7 +14,7 @@ type Props = {
src: Object,
/**
* The component's external style
* The component's external style.
*/
style: Object
};
@ -22,7 +22,7 @@ type Props = {
/**
* A component rendering aN IMAGE.
*
* @extends Component
* @augments Component
*/
export default class ImageImpl extends Component<Props> {
/**

View File

@ -19,7 +19,7 @@ type Props = {
* be an unnecessary duplication and probably an unmaintained list after a
* while.
*
* See list: https://facebook.github.io/react-native/docs/modal
* See list: https://facebook.github.io/react-native/docs/modal.
*/
};

View File

@ -18,9 +18,9 @@ type Props = {
/**
* Implements a React Native {@link Component} that is to be displayed when the
* list is empty
* list is empty.
*
* @extends Component
* @augments Component
*/
class NavigateSectionListEmptyComponent extends Component<Props> {
/**

View File

@ -12,7 +12,7 @@ import styles from './styles';
type Props = {
/**
* item containing data to be rendered
* Item containing data to be rendered.
*/
item: Item,
@ -34,9 +34,9 @@ type Props = {
/**
* Implements a React/Native {@link Component} that renders the Navigate Section
* List Item
* List Item.
*
* @extends Component
* @augments Component
*/
export default class NavigateSectionListItem extends Component<Props> {
/**

View File

@ -11,16 +11,16 @@ import styles from './styles';
type Props = {
/**
* A section containing the data to be rendered
* A section containing the data to be rendered.
*/
section: SetionListSection
}
/**
* Implements a React/Native {@link Component} that renders the section header
* of the list
* of the list.
*
* @extends Component
* @augments Component
*/
export default class NavigateSectionListSectionHeader extends Component<Props> {
/**

View File

@ -63,7 +63,7 @@ type State = {
/**
* A component that renders a paged list.
*
* @extends PagedList
* @augments PagedList
*/
class PagedList extends Component<Props, State> {

View File

@ -10,7 +10,7 @@ type Props = {
children: React$Node,
/**
* Called when the touch is released, but not if cancelled (e.g. by a scroll
* Called when the touch is released, but not if cancelled (e.g. By a scroll
* that steals the responder lock).
*/
onPress: Function

View File

@ -11,7 +11,7 @@ import type { Section } from '../../Types';
import styles from './styles';
/**
* The type of the React {@code Component} props of {@link SectionList}
* The type of the React {@code Component} props of {@link SectionList}.
*/
type Props = {
@ -30,7 +30,7 @@ type Props = {
/**
*
* Functions that defines what happens when the list is pulled for refresh
* Functions that defines what happens when the list is pulled for refresh.
*/
onRefresh: Function,
@ -54,7 +54,7 @@ type Props = {
renderSectionHeader: Object,
/**
* An array of sections
* An array of sections.
*/
sections: Array<Section>
};
@ -62,9 +62,9 @@ type Props = {
/**
* Implements a React Native {@link Component} that wraps the React Native
* SectionList component in a SafeAreaView so that it renders the sectionlist
* within the safe area of the device
* within the safe area of the device.
*
* @extends Component
* @augments Component
*/
export default class SectionList extends Component<Props> {
/**

View File

@ -31,7 +31,7 @@ type Props = {
/**
* Position of the SlidingView: 'left', 'right', 'top', 'bottom'.
* later).
* Later).
*/
position: string,

View File

@ -19,7 +19,7 @@ ColorSchemeRegistry.register('Header', {
},
/**
* Platform specific header button (e.g. back, menu, etc).
* Platform specific header button (e.g. Back, menu, etc).
*/
headerButtonIcon: {
alignSelf: 'center',

View File

@ -62,7 +62,7 @@ type Props = {
/**
* React {@code Component} for showing an icon with a tooltip.
*
* @extends Component
* @augments Component
*/
class BaseIndicator extends Component<Props> {
/**

View File

@ -6,7 +6,7 @@ import type { Props } from '../AbstractContainer';
/**
* Represents a container of React/Web {@link Component} children with a style.
*
* @extends AbstractContainer
* @augments AbstractContainer
*/
export default class Container<P: Props> extends AbstractContainer<P> {
/**

View File

@ -4,7 +4,7 @@ import React, { Component } from 'react';
* Implements a React/Web {@link Component} for displaying image
* in order to facilitate cross-platform source code.
*
* @extends Component
* @augments Component
*/
export default class Image extends Component {
/**

View File

@ -23,7 +23,7 @@ type Props = {
t: Function,
/**
* Indicates whether the support link should be shown in case of an error
* Indicates whether the support link should be shown in case of an error.
*/
showSupportLink: Boolean,
};

View File

@ -84,7 +84,7 @@ function _toTimeString(times) {
* Implements a React/Web {@link Component} for displaying a list with
* meetings.
*
* @extends Component
* @augments Component
*/
class MeetingsList extends Component<Props> {
/**
@ -108,7 +108,7 @@ class MeetingsList extends Component<Props> {
const { listEmptyComponent, meetings, t } = this.props;
/**
* If there are no recent meetings we don't want to display anything
* If there are no recent meetings we don't want to display anything.
*/
if (meetings) {
return (

View File

@ -22,7 +22,7 @@ type Props = {
/**
* Optional footer to show as a last element in the results.
* Should be of type {content: <some content>}
* Should be of type {content: <some content>}.
*/
footer: Object,
@ -73,7 +73,7 @@ type Props = {
shouldFocus: boolean,
/**
* Indicates whether the support link should be shown in case of an error
* Indicates whether the support link should be shown in case of an error.
*/
showSupportLink: Boolean,
};

View File

@ -19,16 +19,16 @@ type Props = {
onPress: ?Function,
/**
* A item containing data to be rendered
* A item containing data to be rendered.
*/
item: Item
};
/**
* Implements a React/Web {@link Component} for displaying an item in a
* NavigateSectionList
* NavigateSectionList.
*
* @extends Component
* @augments Component
*/
export default class NavigateSectionListItem<P: Props>
extends Component<P> {
@ -46,7 +46,8 @@ export default class NavigateSectionListItem<P: Props>
* Initializes the date and duration of the conference to the an empty
* string in case for some reason there is an error where the item data
* lines doesn't contain one or both of those values (even though this
* unlikely the app shouldn't break because of it)
* unlikely the app shouldn't break because of it).
*
* @type {string}
*/
let date = '';

View File

@ -9,16 +9,16 @@ import Text from './Text';
type Props = {
/**
* A section containing the data to be rendered
* A section containing the data to be rendered.
*/
section: Section
}
/**
* Implements a React/Web {@link Component} that renders the section header of
* the list
* the list.
*
* @extends Component
* @augments Component
*/
export default class NavigateSectionListSectionHeader extends Component<Props> {
/**

View File

@ -20,22 +20,22 @@ type Props = {
keyExtractor: Function,
/**
* Returns a React component that renders each Item in the list
* Returns a React component that renders each Item in the list.
*/
renderItem: Function,
/**
* Returns a React component that renders the header for every section
* Returns a React component that renders the header for every section.
*/
renderSectionHeader: Function,
/**
* An array of sections
* An array of sections.
*/
sections: Array<Section>,
/**
* defines what happens when an item in the section list is clicked
* Defines what happens when an item in the section list is clicked.
*/
onItemClick: Function
};
@ -45,7 +45,7 @@ type Props = {
* sections similar to React Native's {@code SectionList} in order to
* facilitate cross-platform source code.
*
* @extends Component
* @augments Component
*/
export default class SectionList extends Component<Props> {
/**
@ -63,7 +63,7 @@ export default class SectionList extends Component<Props> {
} = this.props;
/**
* If there are no recent items we don't want to display anything
* If there are no recent items we don't want to display anything.
*/
if (sections) {
return (

View File

@ -6,7 +6,7 @@ import React, { Component } from 'react';
type Props = {
/**
* ID of the toggle
* ID of the toggle.
*/
id: string,

View File

@ -4,7 +4,7 @@ import React, { Component } from 'react';
* Implements a React/Web {@link Component} for displaying text similar to React
* Native's {@code Text} in order to facilitate cross-platform source code.
*
* @extends Component
* @augments Component
*/
export default class Text extends Component {
/**

View File

@ -44,7 +44,7 @@ type Selector = (state: Object, prevSelection: any) => any;
type RegistrationOptions = {
/**
* @property {boolean} [deepEquals=false] - whether or not a deep equals check should be performed on the selection
* @property {boolean} [deepEquals=false] - Whether or not a deep equals check should be performed on the selection
* returned by {@link Selector}.
*/
deepEquals: ?boolean

View File

@ -10,17 +10,15 @@ import { DEFAULT_SERVER_URL } from './constants';
* a precedence among the values specified by JWT, URL, settings,
* and config.
*
* @param {Object|Function} stateful - The redux state object or
* {@code getState} function.
* @param {Object|Function} stateful - The redux state object or {@code getState} function.
* @param {string} propertyName - The name of the
* configuration/preference/setting (property) to retrieve.
* @param {{
* config: boolean,
* jwt: boolean,
* settings: boolean,
* urlParams: boolean
* }} [sources] - A set/structure of {@code boolean} flags indicating the
* configuration/preference/setting sources to consider/retrieve values from.
* @param {Object} sources - Flags indicating the configuration/preference/setting sources to
* consider/retrieve values from.
* @param {boolean} sources.config - Config.
* @param {boolean} jwt - JWT.
* @param {boolean} settings - Settings.
* @param {boolean} urlParams - URL parameters.
* @returns {any}
*/
export function getPropertyValue(

View File

@ -14,7 +14,7 @@ export type TestHintProps = {
/**
* The indicator which determines whether the test mode is enabled.
* {@link TestHint} components are rendered only if this flag is set to
* {@link TestHint} Components are rendered only if this flag is set to
* {@code true}.
*/
_testModeEnabled: boolean,

View File

@ -20,7 +20,7 @@ type Props = {
* are the possible values:
* 'conference.connectionEstablished'
* 'conference.connectionInterrupted'
* 'conference.connectionRestored'
* 'conference.connectionRestored'.
*/
_conferenceConnectionState: string,

View File

@ -16,7 +16,7 @@ export type Props = {
/**
* Extra styles which will be applied in conjunction with `styles` or
* `toggledStyles` when the button is disabled;
* `toggledStyles` when the button is disabled;.
*/
disabledStyles: ?Styles,

Some files were not shown because too many files have changed in this diff Show More