@proscom/ui-utils - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

lib/es/number/chartLegend.d.ts

@@ -17,2 +17,9 @@ /**
 export declare function getRoundLegendSteps(max: number, min?: number, decimals?: number, maxSteps?: number, minSteps?: number): number;
+/**
+ * Считает оптимальное количество знаков после запятой для легенды графика
+ *
+ * @param min - минимальное значение легенды
+ * @param max - максимальное значение легенды
+ * @param legendSteps - количество шагов легенды
+ */
 export declare function getLegendDecimals(min: number, max: number, legendSteps?: number): number;

lib/es/number/chartLegend.js

@@ -66,2 +66,9 @@ /**
 }
+/**
+ * Считает оптимальное количество знаков после запятой для легенды графика
+ *
+ * @param min - минимальное значение легенды
+ * @param max - максимальное значение легенды
+ * @param legendSteps - количество шагов легенды
+ */
 export function getLegendDecimals(min, max, legendSteps) {
@@ -68,0 +75,0 @@ if (legendSteps === void 0) { legendSteps = 5; }

lib/es/number/formatNumber.d.ts

 /**
- * Форматирует число в русской локали с пробелами-разделителями и запятой
+ * Форматирует число в русской локали с пробелами-разделителями и запятой.
  *
+ * Рекомендуется вместо этой функции использовать Intl.NumberFormat
+ *
  * @param number - число
@@ -5,0 +7,0 @@ * @param decimals - количество знаков после запятой

lib/es/number/formatNumber.js

 import { EMDASH, QUARTERSP } from '../utf';
 import { declinedText } from '../string/declinedText';
 /**
- * Форматирует число в русской локали с пробелами-разделителями и запятой
+ * Форматирует число в русской локали с пробелами-разделителями и запятой.
  *
+ * Рекомендуется вместо этой функции использовать Intl.NumberFormat
+ *
  * @param number - число
@@ -7,0 +9,0 @@ * @param decimals - количество знаков после запятой

lib/es/object/cleanObject.d.ts

 /**
- * Объект без undefined
+ * Объект без undefined полей
  */
 export declare type CleanedObject<Obj extends object> = Pick<Obj, {
-    [Key in keyof Obj]: Obj[Key] extends undefined ? never : Key;
+    [Key in keyof Obj]-?: Obj[Key] extends undefined ? never : Key;
 }[keyof Obj]>;
@@ -7,0 +7,0 @@ /**

lib/es/url.d.ts

@@ -18,4 +18,8 @@ /**
  */
-export declare function stringifyQuerySimple<T>(data: T): string | undefined;
+export declare function encodeQuerySimple<T>(data: T): string | undefined;
 /**
+ * @deprecated use encodeQuerySimple
+ */
+export declare const stringifyQuerySimple: typeof encodeQuerySimple;
+/**
  * Парсит массив, сохраненный в адресной строке через запятую
@@ -22,0 +26,0 @@ * @param query - значение из адресной строки

lib/es/url.js

@@ -37,5 +37,9 @@ /**
  */
-export function stringifyQuerySimple(data) {
+export function encodeQuerySimple(data) {
     return data ? String(data) : undefined;
 }
+/**
+ * @deprecated use encodeQuerySimple
+ */
+export var stringifyQuerySimple = encodeQuerySimple;
 export function parseQueryArray(query) {
@@ -42,0 +46,0 @@ return query ? query.split(',') : null;

lib/number/chartLegend.d.ts

@@ -17,2 +17,9 @@ /**
 export declare function getRoundLegendSteps(max: number, min?: number, decimals?: number, maxSteps?: number, minSteps?: number): number;
+/**
+ * Считает оптимальное количество знаков после запятой для легенды графика
+ *
+ * @param min - минимальное значение легенды
+ * @param max - максимальное значение легенды
+ * @param legendSteps - количество шагов легенды
+ */
 export declare function getLegendDecimals(min: number, max: number, legendSteps?: number): number;

lib/number/chartLegend.js

@@ -71,2 +71,9 @@ "use strict";
 exports.getRoundLegendSteps = getRoundLegendSteps;
+/**
+ * Считает оптимальное количество знаков после запятой для легенды графика
+ *
+ * @param min - минимальное значение легенды
+ * @param max - максимальное значение легенды
+ * @param legendSteps - количество шагов легенды
+ */
 function getLegendDecimals(min, max, legendSteps) {
@@ -73,0 +80,0 @@ if (legendSteps === void 0) { legendSteps = 5; }

lib/number/formatNumber.d.ts

 /**
- * Форматирует число в русской локали с пробелами-разделителями и запятой
+ * Форматирует число в русской локали с пробелами-разделителями и запятой.
  *
+ * Рекомендуется вместо этой функции использовать Intl.NumberFormat
+ *
  * @param number - число
@@ -5,0 +7,0 @@ * @param decimals - количество знаков после запятой

lib/number/formatNumber.js

@@ -7,4 +7,6 @@ "use strict";
 /**
- * Форматирует число в русской локали с пробелами-разделителями и запятой
+ * Форматирует число в русской локали с пробелами-разделителями и запятой.
  *
+ * Рекомендуется вместо этой функции использовать Intl.NumberFormat
+ *
  * @param number - число
@@ -11,0 +13,0 @@ * @param decimals - количество знаков после запятой

lib/object/cleanObject.d.ts

 /**
- * Объект без undefined
+ * Объект без undefined полей
  */
 export declare type CleanedObject<Obj extends object> = Pick<Obj, {
-    [Key in keyof Obj]: Obj[Key] extends undefined ? never : Key;
+    [Key in keyof Obj]-?: Obj[Key] extends undefined ? never : Key;
 }[keyof Obj]>;
@@ -7,0 +7,0 @@ /**

lib/url.d.ts

@@ -18,4 +18,8 @@ /**
  */
-export declare function stringifyQuerySimple<T>(data: T): string | undefined;
+export declare function encodeQuerySimple<T>(data: T): string | undefined;
 /**
+ * @deprecated use encodeQuerySimple
+ */
+export declare const stringifyQuerySimple: typeof encodeQuerySimple;
+/**
  * Парсит массив, сохраненный в адресной строке через запятую
@@ -22,0 +26,0 @@ * @param query - значение из адресной строки

lib/url.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeQueryArray = exports.parseQueryArray = exports.stringifyQuerySimple = exports.parseQuerySimple = exports.getParentUrl = void 0;
+exports.encodeQueryArray = exports.parseQueryArray = exports.stringifyQuerySimple = exports.encodeQuerySimple = exports.parseQuerySimple = exports.getParentUrl = void 0;
 /**
@@ -42,6 +42,10 @@ * Рассчитывает родительский адрес, убирая нужное число элементов справа
  */
-function stringifyQuerySimple(data) {
+function encodeQuerySimple(data) {
     return data ? String(data) : undefined;
 }
-exports.stringifyQuerySimple = stringifyQuerySimple;
+exports.encodeQuerySimple = encodeQuerySimple;
+/**
+ * @deprecated use encodeQuerySimple
+ */
+exports.stringifyQuerySimple = encodeQuerySimple;
 function parseQueryArray(query) {
@@ -48,0 +52,0 @@ return query ? query.split(',') : null;

package.json

 {
   "name": "@proscom/ui-utils",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Proscom UI utilities",
@@ -38,3 +38,4 @@ "author": "Andrew Starostin <[e-mail]>",
     "rimraf": "^3.0.2"
-  }
+  },
+  "gitHead": "126f5230485ee9f723aea18af791a8e994e83d8f"
 }

README.md

@@ -12,1 +12,94 @@ # `@proscom/ui-utils`
 ```
+
+## Состав
+
+### Асинхронщина
+
+- [delayPromise](./src/async/delayPromise.ts)
+- [singleton](./src/async/singleton.ts)
+
+### Хелперы
+
+- [EnumHelpers](./src/helpers/EnumHelpers.ts)
+- [SingleTimeoutManager](./src/helpers/SingleTimeoutManager.ts)
+
+### Работа с числами
+
+- Легенда для графиков
+  - [roundToRound](./src/number/chartLegend.ts)
+  - [getRoundLegendSteps](./src/number/chartLegend.ts)
+  - [getLegendDecimals](./src/number/chartLegend.ts)
+- Показатели для графиков
+  - [getIndexDecimals](./src/number/indexes.ts)
+  - [formatIndexValue](./src/number/indexes.ts)
+  - [formatIndexValueUnit](./src/number/indexes.ts)
+- Форматирование
+  - [formatFileSize](./src/number/formatFileSize.ts)
+  - [formatNumber](./src/number/formatNumber.ts)
+  - [formatValueUnit](./src/number/formatNumber.ts)
+  - [formatPercent](./src/number/formatNumber.ts)
+  - [declineUnit](./src/number/formatNumber.ts)
+- Остальное
+  - [findMinIndex](./src/number/findMinIndex.ts)
+  - [findMinWrapped](./src/number/findMinIndex.ts)
+  - [getRandomInteger](./src/number/random.ts)
+  - [isValidNumber](./src/number/tryNumber.ts)
+  - [tryNumber](./src/number/tryNumber.ts)
+
+### Работа с объектами
+
+- [applyDefaults](./src/object/applyDefaults.ts)
+- [areArraysShallowEqual](./src/object/areArraysShallowEqual.ts)
+- [cleanObject](./src/object/cleanObject.ts)
+- [createFilterSearch](./src/object/filterSearch.ts)
+- [filterSearch](./src/object/filterSearch.ts)
+- [insertPaginatedSlice](./src/object/insertPaginatedSlice.ts)
+- [tryParseJson](./src/object/tryParseJson.ts)
+
+### Сортировка
+
+- [makeComparator](./src/sorting/makeComparator.ts)
+- [makeMultiComparator](./src/sorting/makeComparator.ts)
+- [compareSimple](./src/sorting/makeComparator.ts)
+- [compareNumericStrings](./src/sorting/compareNumericStrings.ts)
+
+### Работа со строками
+
+- [declinedText](./src/string/declinedText.ts)
+- [joinNonEmpty](./src/string/joinNonEmpty.ts)
+- [makeOptionator](./src/string/makeOptionator.ts)
+- [shortenText](./src/string/shortenText.ts)
+
+### Типы TypeScript
+
+- [Optional](./src/types.ts)
+- [Extends](./src/types.ts)
+
+### Работа с адресной строкой
+
+- [getParentUrl](./src/url.ts)
+- [parseQuerySimple](./src/url.ts)
+- [encodeQuerySimple](./src/url.ts)
+- [parseQueryArray](./src/url.ts)
+- [encodeQueryArray](./src/url.ts)
+
+### Константы для некоторых Unicode-символов
+
+| Константа | utf8   | Символ | Описание               |
+| --------- | ------ | ------ | ---------------------- |
+| LAQUO     | \u00AB | «      | Левые двойные кавычки  |
+| RAQUO     | \u00BB | »      | Правые двойные кавычки |
+| EMDASH    | \u2014 | —      | Длинное тире           |
+| THINSP    | \u2009 |        | Тонкий пробел          |
+| QUARTERSP | \u2005 |        | Четвертной пробел      |
+| THIRDSP   | \u2004 |        | Третичный пробел       |
+| ENSP      | \u2002 |        | N-пробел               |
+| EMSP      | \u2001 |        | M-пробел               |
+| NBSP      | \u00A0 |        | Неразрывный пробел     |
+| HELLIP    | \u2026 | …      | Многоточие             |
+| LSAQUO    | \u2039 | ‹      | Левая кавычка          |
+| RSAQUO    | \u203A | ›      | Правая кавычка         |
+| RUBLE     | \u20BD | ₽      | Символ рубля           |
+| LEQ       | \u2264 | ≤      | Меньше или равно       |
+| NEQ       | \u2260 | ≠      | Не равно               |
+| GEQ       | \u2265 | ≥      | Больше или равно       |

src/number/chartLegend.ts

@@ -71,2 +71,9 @@ /**
 
+/**
+ * Считает оптимальное количество знаков после запятой для легенды графика
+ *
+ * @param min - минимальное значение легенды
+ * @param max - максимальное значение легенды
+ * @param legendSteps - количество шагов легенды
+ */
 export function getLegendDecimals(min: number, max: number, legendSteps = 5) {
@@ -73,0 +80,0 @@ let step = Math.abs((max - min) / legendSteps);

src/number/formatNumber.ts

@@ -5,4 +5,6 @@ import { EMDASH, QUARTERSP } from '../utf';
 /**
- * Форматирует число в русской локали с пробелами-разделителями и запятой
+ * Форматирует число в русской локали с пробелами-разделителями и запятой.
  *
+ * Рекомендуется вместо этой функции использовать Intl.NumberFormat
+ *
  * @param number - число
@@ -9,0 +11,0 @@ * @param decimals - количество знаков после запятой

src/object/cleanObject.ts

 /**
- * Объект без undefined
+ * Объект без undefined полей
  */
@@ -7,3 +7,3 @@ export type CleanedObject<Obj extends object> = Pick<
   {
-    [Key in keyof Obj]: Obj[Key] extends undefined ? never : Key;
+    [Key in keyof Obj]-?: Obj[Key] extends undefined ? never : Key;
   }[keyof Obj]
@@ -10,0 +10,0 @@ >;

src/url.ts

@@ -37,3 +37,3 @@ /**
  */
-export function stringifyQuerySimple<T>(data: T) {
+export function encodeQuerySimple<T>(data: T) {
   return data ? String(data) : undefined
@@ -43,2 +43,7 @@ }
 /**
+ * @deprecated use encodeQuerySimple
+ */
+export const stringifyQuerySimple = encodeQuerySimple;
+
+/**
  * Парсит массив, сохраненный в адресной строке через запятую
@@ -45,0 +50,0 @@ * @param query - значение из адресной строки

No alert changes

Improved metrics

Total package byte prevSize

212518

increased by3.41%

Lines of code

3888

increased by1.7%

Number of lines in readme file

105

increased by775%

No dependency changes