@etsoo/shared 1.1.93 → 1.1.95

package/README.md

@@ -105,7 +105,7 @@ Array related utilities
 |toUnique|Make all items are unique|
 
 ## DataTypes
-Data type definitions and type safe functions. ListItemType and ListItemType1 are sugar types.
+Data type definitions and type safe functions. ListItemType, ListItemType1 and ListItemType2 are sugar types.
 
 |Name|Description|
 |---:|---|
@@ -231,6 +231,7 @@ Numbers related utilities
 |---:|---|
 |format|Format number|
 |formatMoney|Format money number|
+|getCurrencySymbol|Get currency symbol or name from ISO code|
 |parse|Parse float value|
 |toExact|To the exact precision number avoiding precision lost|
 

package/__tests__/NumberUtils.ts

@@ -11,6 +11,17 @@ test('Tests for formatMoney', () => {
     expect(NumberUtils.formatMoney(1282, 'CNY', 'zh-CN', true)).toBe('¥1,282');
 });
 
+test('Tests for getCurrencySymbol', () => {
+    expect(NumberUtils.getCurrencySymbol('CNY')).toBe('¥');
+    expect(NumberUtils.getCurrencySymbol('USD')).toBe('$');
+
+    // When locale = 'en-US' will be failed with '$'
+    expect(NumberUtils.getCurrencySymbol('USD', 'symbol', 'zh-CN')).toBe('US$');
+    expect(NumberUtils.getCurrencySymbol('CNY', 'name', 'zh-CN')).toBe(
+        '人民币'
+    );
+});
+
 test('Tests for parse', () => {
     expect(NumberUtils.parse('123')).toBe(123);
     expect(NumberUtils.parse(Object(123))).toBe(123);

package/lib/cjs/DataTypes.d.ts

@@ -395,6 +395,16 @@ export type ListType = DataTypes.IdLabelItem<number>;
  * List item with string id type
  */
 export type ListType1 = DataTypes.IdLabelItem<string>;
+/**
+ * List item with compatible id and name / label
+ */
+export type ListType2 = {
+    id: DataTypes.IdType;
+} & ({
+    label: string;
+} | {
+    name: string;
+});
 /**
  * Id default type
  */

package/lib/cjs/NumberUtils.d.ts

@@ -26,6 +26,14 @@ export declare namespace NumberUtils {
      * @returns Result
      */
     function formatMoney(input: number | bigint, currency?: string, locale?: string | string[], isInteger?: boolean, options?: Intl.NumberFormatOptions): string;
+    /**
+     * Get currency symbol or name from ISO code
+     * @param code ISO currency code, like USD / CNY
+     * @param display Display format
+     * @param locale Locale
+     * @returns Result
+     */
+    function getCurrencySymbol(code: string, display?: 'symbol' | 'narrowSymbol' | 'name', locale?: string): string | undefined;
     /**
      * Parse float value
      * @param rawData Raw data

package/lib/cjs/NumberUtils.js

@@ -50,6 +50,25 @@ var NumberUtils;
         return format(input, locale, options);
     }
     NumberUtils.formatMoney = formatMoney;
+    /**
+     * Get currency symbol or name from ISO code
+     * @param code ISO currency code, like USD / CNY
+     * @param display Display format
+     * @param locale Locale
+     * @returns Result
+     */
+    function getCurrencySymbol(code, display = 'narrowSymbol', locale) {
+        var _a;
+        const formatter = new Intl.NumberFormat(locale, {
+            style: 'currency',
+            currency: code,
+            currencyDisplay: display
+        });
+        const parts = formatter.formatToParts();
+        const symbol = (_a = parts.find((part) => part.type === 'currency')) === null || _a === void 0 ? void 0 : _a.value;
+        return symbol;
+    }
+    NumberUtils.getCurrencySymbol = getCurrencySymbol;
     /**
      * Parse float value
      * @param rawData Raw data

package/lib/mjs/DataTypes.d.ts

@@ -395,6 +395,16 @@ export type ListType = DataTypes.IdLabelItem<number>;
  * List item with string id type
  */
 export type ListType1 = DataTypes.IdLabelItem<string>;
+/**
+ * List item with compatible id and name / label
+ */
+export type ListType2 = {
+    id: DataTypes.IdType;
+} & ({
+    label: string;
+} | {
+    name: string;
+});
 /**
  * Id default type
  */

package/lib/mjs/NumberUtils.d.ts

@@ -26,6 +26,14 @@ export declare namespace NumberUtils {
      * @returns Result
      */
     function formatMoney(input: number | bigint, currency?: string, locale?: string | string[], isInteger?: boolean, options?: Intl.NumberFormatOptions): string;
+    /**
+     * Get currency symbol or name from ISO code
+     * @param code ISO currency code, like USD / CNY
+     * @param display Display format
+     * @param locale Locale
+     * @returns Result
+     */
+    function getCurrencySymbol(code: string, display?: 'symbol' | 'narrowSymbol' | 'name', locale?: string): string | undefined;
     /**
      * Parse float value
      * @param rawData Raw data

package/lib/mjs/NumberUtils.js

@@ -47,6 +47,25 @@ export var NumberUtils;
         return format(input, locale, options);
     }
     NumberUtils.formatMoney = formatMoney;
+    /**
+     * Get currency symbol or name from ISO code
+     * @param code ISO currency code, like USD / CNY
+     * @param display Display format
+     * @param locale Locale
+     * @returns Result
+     */
+    function getCurrencySymbol(code, display = 'narrowSymbol', locale) {
+        var _a;
+        const formatter = new Intl.NumberFormat(locale, {
+            style: 'currency',
+            currency: code,
+            currencyDisplay: display
+        });
+        const parts = formatter.formatToParts();
+        const symbol = (_a = parts.find((part) => part.type === 'currency')) === null || _a === void 0 ? void 0 : _a.value;
+        return symbol;
+    }
+    NumberUtils.getCurrencySymbol = getCurrencySymbol;
     /**
      * Parse float value
      * @param rawData Raw data

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.93",
+    "version": "1.1.95",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/DataTypes.ts

@@ -754,6 +754,13 @@ export type ListType = DataTypes.IdLabelItem<number>;
  */
 export type ListType1 = DataTypes.IdLabelItem<string>;
 
+/**
+ * List item with compatible id and name / label
+ */
+export type ListType2 = {
+    id: DataTypes.IdType;
+} & ({ label: string } | { name: string });
+
 /**
  * Id default type
  */

package/src/NumberUtils.ts

@@ -66,6 +66,30 @@ export namespace NumberUtils {
         return format(input, locale, options);
     }
 
+    /**
+     * Get currency symbol or name from ISO code
+     * @param code ISO currency code, like USD / CNY
+     * @param display Display format
+     * @param locale Locale
+     * @returns Result
+     */
+    export function getCurrencySymbol(
+        code: string,
+        display: 'symbol' | 'narrowSymbol' | 'name' = 'narrowSymbol',
+        locale?: string
+    ): string | undefined {
+        const formatter = new Intl.NumberFormat(locale, {
+            style: 'currency',
+            currency: code,
+            currencyDisplay: display
+        });
+
+        const parts = formatter.formatToParts();
+        const symbol = parts.find((part) => part.type === 'currency')?.value;
+
+        return symbol;
+    }
+
     /**
      * Parse float value
      * @param rawData Raw data