queer-af/mastodon
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add type annotation for RelativeTimestamp component (#24749)

Browse source
This commit is contained in:
fusagiko / takayamaki 2023-05-01 07:51:31 +09:00 committed by GitHub
parent 81f75b1e0e
commit 15fd712464
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
app/javascript/mastodon/components/relative_timestamp.jsx → app/javascript/mastodon/components/relative_timestamp.tsx
View file

@ -1,6 +1,5 @@
import React from 'react'; import React from 'react';
import { injectIntl, defineMessages } from 'react-intl'; import { injectIntl, defineMessages, InjectedIntl } from 'react-intl';
import PropTypes from 'prop-types';
const messages = defineMessages({ const messages = defineMessages({
today: { id: 'relative_time.today', defaultMessage: 'today' }, today: { id: 'relative_time.today', defaultMessage: 'today' },
@ -28,12 +27,12 @@ const dateFormatOptions = {
day: '2-digit', day: '2-digit',
hour: '2-digit', hour: '2-digit',
minute: '2-digit', minute: '2-digit',
}; } as const;
const shortDateFormatOptions = { const shortDateFormatOptions = {
month: 'short', month: 'short',
day: 'numeric', day: 'numeric',
}; } as const;
const SECOND = 1000; const SECOND = 1000;
const MINUTE = 1000 * 60; const MINUTE = 1000 * 60;
@ -42,7 +41,7 @@ const DAY = 1000 * 60 * 60 * 24;
const MAX_DELAY = 2147483647; const MAX_DELAY = 2147483647;
const selectUnits = delta => { const selectUnits = (delta: number) => {
const absDelta = Math.abs(delta); const absDelta = Math.abs(delta);
if (absDelta < MINUTE) { if (absDelta < MINUTE) {
@ -56,7 +55,7 @@ const selectUnits = delta => {
return 'day'; return 'day';
}; };
const getUnitDelay = units => { const getUnitDelay = (units: string) => {
switch (units) { switch (units) {
case 'second': case 'second':
return SECOND; return SECOND;
@ -71,7 +70,7 @@ const getUnitDelay = units => {
} }
}; };
export const timeAgoString = (intl, date, now, year, timeGiven, short) => { export const timeAgoString = (intl: InjectedIntl, date: Date, now: number, year: number, timeGiven: boolean, short?: boolean) => {
const delta = now - date.getTime(); const delta = now - date.getTime();
let relativeTime; let relativeTime;
@ -99,7 +98,7 @@ export const timeAgoString = (intl, date, now, year, timeGiven, short) => {
return relativeTime; return relativeTime;
}; };
const timeRemainingString = (intl, date, now, timeGiven = true) => { const timeRemainingString = (intl: InjectedIntl, date: Date, now: number, timeGiven = true) => {
const delta = date.getTime() - now; const delta = date.getTime() - now;
let relativeTime; let relativeTime;
@ -121,15 +120,17 @@ const timeRemainingString = (intl, date, now, timeGiven = true) => {
return relativeTime; return relativeTime;
}; };
class RelativeTimestamp extends React.Component { type Props = {
intl: InjectedIntl;
static propTypes = { timestamp: string;
intl: PropTypes.object.isRequired, year: number;
timestamp: PropTypes.string.isRequired, futureDate?: boolean;
year: PropTypes.number.isRequired, short?: boolean;
futureDate: PropTypes.bool, }
short: PropTypes.bool, type States = {
}; now: number;
}
class RelativeTimestamp extends React.Component<Props, States> {
state = { state = {
now: this.props.intl.now(), now: this.props.intl.now(),
@ -140,7 +141,9 @@ class RelativeTimestamp extends React.Component {
short: true, short: true,
}; };
shouldComponentUpdate (nextProps, nextState) { _timer: number | undefined;
shouldComponentUpdate (nextProps: Props, nextState: States) {
// As of right now the locale doesn't change without a new page load, // As of right now the locale doesn't change without a new page load,
// but we might as well check in case that ever changes. // but we might as well check in case that ever changes.
return this.props.timestamp !== nextProps.timestamp || return this.props.timestamp !== nextProps.timestamp ||
@ -148,7 +151,7 @@ class RelativeTimestamp extends React.Component {
this.state.now !== nextState.now; this.state.now !== nextState.now;
} }
componentWillReceiveProps (nextProps) { UNSAFE_componentWillReceiveProps (nextProps: Props) {
if (this.props.timestamp !== nextProps.timestamp) { if (this.props.timestamp !== nextProps.timestamp) {
this.setState({ now: this.props.intl.now() }); this.setState({ now: this.props.intl.now() });
} }
@ -158,16 +161,16 @@ class RelativeTimestamp extends React.Component {
this._scheduleNextUpdate(this.props, this.state); this._scheduleNextUpdate(this.props, this.state);
} }
componentWillUpdate (nextProps, nextState) { UNSAFE_componentWillUpdate (nextProps: Props, nextState: States) {
this._scheduleNextUpdate(nextProps, nextState); this._scheduleNextUpdate(nextProps, nextState);
} }
componentWillUnmount () { componentWillUnmount () {
clearTimeout(this._timer); window.clearTimeout(this._timer);
} }
_scheduleNextUpdate (props, state) { _scheduleNextUpdate (props: Props, state: States) {
clearTimeout(this._timer); window.clearTimeout(this._timer);
const { timestamp } = props; const { timestamp } = props;
const delta = (new Date(timestamp)).getTime() - state.now; const delta = (new Date(timestamp)).getTime() - state.now;
@ -176,7 +179,7 @@ class RelativeTimestamp extends React.Component {
const updateInterval = 1000 * 10; const updateInterval = 1000 * 10;
const delay = delta < 0 ? Math.max(updateInterval, unitDelay - unitRemainder) : Math.max(updateInterval, unitRemainder); const delay = delta < 0 ? Math.max(updateInterval, unitDelay - unitRemainder) : Math.max(updateInterval, unitRemainder);
this._timer = setTimeout(() => { this._timer = window.setTimeout(() => {
this.setState({ now: this.props.intl.now() }); this.setState({ now: this.props.intl.now() });
}, delay); }, delay);
} }