Skip to content

Commit

Permalink
Added explicit return type in date utils
Browse files Browse the repository at this point in the history
Signed-off-by: Prathamesh Mutkure <pmutkure009@gmail.com>
  • Loading branch information
prathamesh-mutkure committed Sep 18, 2023
1 parent 003d2aa commit 2a71e75
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions packages/jaeger-ui/src/utils/date.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,42 +63,42 @@ const timeUnitToShortTermMapper: {
* @param {number} totalDuration
* @return {number} 0-100 percentage
*/
export function getPercentageOfDuration(duration: number, totalDuration: number) {
export function getPercentageOfDuration(duration: number, totalDuration: number): number {
return (duration / totalDuration) * 100;
}

const quantizeDuration = (duration: number, floatPrecision: number, conversionFactor: number) =>
const quantizeDuration = (duration: number, floatPrecision: number, conversionFactor: number): number =>
toFloatPrecision(duration / conversionFactor, floatPrecision) * conversionFactor;

/**
* @param {number} duration (in microseconds)
* @return {string} formatted, unit-labelled string with time in milliseconds
*/
export function formatDate(duration: number) {
export function formatDate(duration: number): string {
return dayjs(duration / ONE_MILLISECOND).format(STANDARD_DATE_FORMAT);
}

/**
* @param {number} duration (in microseconds)
* @return {string} formatted, unit-labelled string with time in milliseconds
*/
export function formatTime(duration: number) {
export function formatTime(duration: number): string {
return dayjs(duration / ONE_MILLISECOND).format(STANDARD_TIME_FORMAT);
}

/**
* @param {number} duration (in microseconds)
* @return {string} formatted, unit-labelled string with time in milliseconds
*/
export function formatDatetime(duration: number) {
export function formatDatetime(duration: number): string {
return dayjs(duration / ONE_MILLISECOND).format(STANDARD_DATETIME_FORMAT);
}

/**
* @param {number} duration (in microseconds)
* @return {string} formatted, unit-labelled string with time in milliseconds
*/
export function formatMillisecondTime(duration: number) {
export function formatMillisecondTime(duration: number): string {

Check warning on line 101 in packages/jaeger-ui/src/utils/date.tsx

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/date.tsx#L101

Added line #L101 was not covered by tests
const targetDuration = quantizeDuration(duration, DEFAULT_MS_PRECISION, ONE_MILLISECOND);
return `${dayjs.duration(targetDuration / ONE_MILLISECOND).asMilliseconds()}ms`;

Check warning on line 103 in packages/jaeger-ui/src/utils/date.tsx

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/date.tsx#L103

Added line #L103 was not covered by tests
}
Expand All @@ -107,7 +107,7 @@ export function formatMillisecondTime(duration: number) {
* @param {number} duration (in microseconds)
* @return {string} formatted, unit-labelled string with time in seconds
*/
export function formatSecondTime(duration: number) {
export function formatSecondTime(duration: number): string {

Check warning on line 110 in packages/jaeger-ui/src/utils/date.tsx

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/date.tsx#L110

Added line #L110 was not covered by tests
const targetDuration = quantizeDuration(duration, DEFAULT_MS_PRECISION, ONE_SECOND);
return `${dayjs.duration(targetDuration / ONE_MILLISECOND).asSeconds()}s`;

Check warning on line 112 in packages/jaeger-ui/src/utils/date.tsx

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/date.tsx#L112

Added line #L112 was not covered by tests
}
Expand Down Expand Up @@ -142,7 +142,7 @@ export function formatDuration(duration: number): string {
return secondaryValue === 0 ? primaryUnitString : `${primaryUnitString} ${secondaryUnitString}`;
}

export function formatRelativeDate(value: any, fullMonthName = false) {
export function formatRelativeDate(value: any, fullMonthName = false): string {
const m = dayjs.isDayjs(value) ? value : dayjs(value);

const monthFormat = fullMonthName ? 'MMMM' : 'MMM';
Expand Down Expand Up @@ -189,15 +189,15 @@ export function convertTimeUnitToShortTerm(timeUnit: LongTimeUnit): ShortTimeUni
return timeUnitToShortTermMapper[timeUnit] ?? '';
}

export function convertToTimeUnit(microseconds: number, targetTimeUnit: string) {
export function convertToTimeUnit(microseconds: number, targetTimeUnit: string): number {
if (microseconds < 1000) {
return microseconds;
}

return dayjs.duration(microseconds / 1000, 'ms').as(targetTimeUnit as DurationUnitType);
}

export function timeConversion(microseconds: number) {
export function timeConversion(microseconds: number): string {
if (microseconds < 1000) {
return `${microseconds}μs`;
}
Expand Down

0 comments on commit 2a71e75

Please sign in to comment.