Skip to content

Commit

Permalink
Remove @hidden for functions
Browse files Browse the repository at this point in the history
  • Loading branch information
cocopon committed Feb 24, 2023
1 parent f3f7f91 commit 492db13
Show file tree
Hide file tree
Showing 16 changed files with 1 addition and 147 deletions.
10 changes: 1 addition & 9 deletions packages/core/src/common/converter/boolean.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
/**
* @hidden
*/
export function boolToString(value: boolean): string {
return String(value);
}
/**
* @hidden
*/

export function boolFromUnknown(value: unknown): boolean {
if (value === 'false') {
return false;
}
return !!value;
}

/**
* @hidden
*/
export function BooleanFormatter(value: boolean): string {
return boolToString(value);
}
12 changes: 0 additions & 12 deletions packages/core/src/common/converter/number.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,11 @@ import {isEmpty} from '../../misc/type-util';
import {parseEcmaNumberExpression} from './ecma/parser';
import {Formatter} from './formatter';

/**
* @hidden
*/
export function parseNumber(text: string): number | null {
const r = parseEcmaNumberExpression(text);
return r?.evaluate() ?? null;
}

/**
* @hidden
*/
export function numberFromUnknown(value: unknown): number {
if (typeof value === 'number') {
return value;
Expand All @@ -28,16 +22,10 @@ export function numberFromUnknown(value: unknown): number {
return 0;
}

/**
* @hidden
*/
export function numberToString(value: number): string {
return String(value);
}

/**
* @hidden
*/
export function createNumberFormatter(digits: number): Formatter<number> {
return (value: number): string => {
return value.toFixed(Math.max(Math.min(digits, 20), 0));
Expand Down
3 changes: 0 additions & 3 deletions packages/core/src/common/converter/percentage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ import {createNumberFormatter} from './number';

const innerFormatter = createNumberFormatter(0);

/**
* @hidden
*/
export function formatPercentage(value: number): string {
return innerFormatter(value) + '%';
}
6 changes: 0 additions & 6 deletions packages/core/src/common/converter/string.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
/**
* @hidden
*/
export function stringFromUnknown(value: unknown): string {
return String(value);
}

/**
* @hidden
*/
export function formatString(value: string): string {
return value;
}
6 changes: 0 additions & 6 deletions packages/core/src/common/model/buffered-value.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ function fillBuffer<T>(buffer: TpBuffer<T>, bufferSize: number) {
}
}

/**
* @hidden
*/
export function initializeBuffer<T>(bufferSize: number): TpBuffer<T> {
const buffer: TpBuffer<T> = [];
fillBuffer(buffer, bufferSize);
Expand All @@ -29,9 +26,6 @@ function createTrimmedBuffer<T>(buffer: TpBuffer<T>): T[] {
return forceCast(index < 0 ? buffer : buffer.slice(0, index));
}

/**
* @hidden
*/
export function createPushedBuffer<T>(
buffer: TpBuffer<T>,
newValue: T,
Expand Down
15 changes: 0 additions & 15 deletions packages/core/src/common/ui.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ interface StepKeys {
upKey: boolean;
}

/**
* @hidden
*/
export function getStepForKey(baseStep: number, keys: StepKeys): number {
const step = baseStep * (keys.altKey ? 0.1 : 1) * (keys.shiftKey ? 10 : 1);

Expand All @@ -19,9 +16,6 @@ export function getStepForKey(baseStep: number, keys: StepKeys): number {
return 0;
}

/**
* @hidden
*/
export function getVerticalStepKeys(ev: KeyboardEvent): StepKeys {
return {
altKey: ev.altKey,
Expand All @@ -31,9 +25,6 @@ export function getVerticalStepKeys(ev: KeyboardEvent): StepKeys {
};
}

/**
* @hidden
*/
export function getHorizontalStepKeys(ev: KeyboardEvent): StepKeys {
return {
altKey: ev.altKey,
Expand All @@ -43,16 +34,10 @@ export function getHorizontalStepKeys(ev: KeyboardEvent): StepKeys {
};
}

/**
* @hidden
*/
export function isVerticalArrowKey(key: string): boolean {
return key === 'ArrowUp' || key === 'ArrowDown';
}

/**
* @hidden
*/
export function isArrowKey(key: string): boolean {
return isVerticalArrowKey(key) || key === 'ArrowLeft' || key === 'ArrowRight';
}
9 changes: 0 additions & 9 deletions packages/core/src/common/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ function findStep(constraint: Constraint<number> | undefined): number | null {
return c.step;
}

/**
* @hidden
*/
export function getSuitableDecimalDigits(
constraint: Constraint<number> | undefined,
rawValue: number,
Expand All @@ -106,19 +103,13 @@ export function getSuitableDecimalDigits(
return Math.max(getDecimalDigits(rawValue), 2);
}

/**
* @hidden
*/
export function getBaseStep(
constraint: Constraint<number> | undefined,
): number {
const step = findStep(constraint);
return step ?? 1;
}

/**
* @hidden
*/
export function getSuitableDraggingScale(
constraint: Constraint<number> | undefined,
rawValue: number,
Expand Down
18 changes: 0 additions & 18 deletions packages/core/src/input-binding/color/converter/color-number.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ import {mapRange} from '../../../common/number-util';
import {removeAlphaComponent} from '../model/color-model';
import {IntColor} from '../model/int-color';

/**
* @hidden
*/
export function colorToRgbNumber(value: IntColor): number {
return removeAlphaComponent(value.getComponents('rgb')).reduce(
(result, comp) => {
Expand All @@ -14,9 +11,6 @@ export function colorToRgbNumber(value: IntColor): number {
);
}

/**
* @hidden
*/
export function colorToRgbaNumber(value: IntColor): number {
return (
value.getComponents('rgb').reduce((result, comp, index) => {
Expand All @@ -26,19 +20,13 @@ export function colorToRgbaNumber(value: IntColor): number {
);
}

/**
* @hidden
*/
export function numberToRgbColor(num: number): IntColor {
return new IntColor(
[(num >> 16) & 0xff, (num >> 8) & 0xff, num & 0xff],
'rgb',
);
}

/**
* @hidden
*/
export function numberToRgbaColor(num: number): IntColor {
return new IntColor(
[
Expand All @@ -51,19 +39,13 @@ export function numberToRgbaColor(num: number): IntColor {
);
}

/**
* @hidden
*/
export function colorFromRgbNumber(value: unknown): IntColor {
if (typeof value !== 'number') {
return IntColor.black();
}
return numberToRgbColor(value);
}

/**
* @hidden
*/
export function colorFromRgbaNumber(value: unknown): IntColor {
if (typeof value !== 'number') {
return IntColor.black();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ import {mapColorType} from '../model/colors';
import {FloatColor} from '../model/float-color';
import {IntColor} from '../model/int-color';

/**
* @hidden
*/
export function colorFromObject(value: unknown, type: 'int'): IntColor;
export function colorFromObject(value: unknown, type: 'float'): FloatColor;
export function colorFromObject(value: unknown, type: ColorType): Color;
Expand Down
24 changes: 0 additions & 24 deletions packages/core/src/input-binding/color/converter/color-string.ts
Original file line number Diff line number Diff line change
Expand Up @@ -454,19 +454,13 @@ function zerofill(comp: number): string {
return hex.length === 1 ? `0${hex}` : hex;
}

/**
* @hidden
*/
export function colorToHexRgbString(value: IntColor, prefix = '#'): string {
const hexes = removeAlphaComponent(value.getComponents('rgb'))
.map(zerofill)
.join('');
return `${prefix}${hexes}`;
}

/**
* @hidden
*/
export function colorToHexRgbaString(value: IntColor, prefix = '#'): string {
const rgbaComps = value.getComponents('rgb');
const hexes = [rgbaComps[0], rgbaComps[1], rgbaComps[2], rgbaComps[3] * 255]
Expand All @@ -475,9 +469,6 @@ export function colorToHexRgbaString(value: IntColor, prefix = '#'): string {
return `${prefix}${hexes}`;
}

/**
* @hidden
*/
export function colorToFunctionalRgbString(value: Color): string {
const formatter = createNumberFormatter(0);
const ci = mapColorType(value, 'int');
Expand All @@ -487,9 +478,6 @@ export function colorToFunctionalRgbString(value: Color): string {
return `rgb(${comps.join(', ')})`;
}

/**
* @hidden
*/
export function colorToFunctionalRgbaString(value: Color): string {
const aFormatter = createNumberFormatter(2);
const rgbFormatter = createNumberFormatter(0);
Expand All @@ -501,9 +489,6 @@ export function colorToFunctionalRgbaString(value: Color): string {
return `rgba(${comps.join(', ')})`;
}

/**
* @hidden
*/
export function colorToFunctionalHslString(value: Color): string {
const formatters = [
createNumberFormatter(0),
Expand All @@ -517,9 +502,6 @@ export function colorToFunctionalHslString(value: Color): string {
return `hsl(${comps.join(', ')})`;
}

/**
* @hidden
*/
export function colorToFunctionalHslaString(value: Color): string {
const formatters = [
createNumberFormatter(0),
Expand All @@ -534,9 +516,6 @@ export function colorToFunctionalHslaString(value: Color): string {
return `hsla(${comps.join(', ')})`;
}

/**
* @hidden
*/
export function colorToObjectRgbString(value: Color, type: ColorType): string {
const formatter = createNumberFormatter(type === 'float' ? 2 : 0);
const names = ['r', 'g', 'b'];
Expand All @@ -551,9 +530,6 @@ function createObjectRgbColorFormatter(type: ColorType): Formatter<Color> {
return (value) => colorToObjectRgbString(value, type);
}

/**
* @hidden
*/
export function colorToObjectRgbaString(value: Color, type: ColorType): string {
const aFormatter = createNumberFormatter(2);
const rgbFormatter = createNumberFormatter(type === 'float' ? 2 : 0);
Expand Down
Loading

0 comments on commit 492db13

Please sign in to comment.