@yelon/util 17.3.2 → 18.0.0

package/form/validators.d.ts

@@ -1,62 +1,62 @@
-import { AbstractControl, ValidationErrors } from '@angular/forms';
-/**
- * A set of validators for reactive forms
- *
- * 一套用于响应式表单的验证器
- */
-export declare class _Validators {
-    /**
-     * Wheter is number
-     *
-     * 是否为数字
-     */
-    static num(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is integer
-     *
-     * 是否为整数
-     */
-    static int(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is decimal
-     *
-     * 是否为小数点数值
-     */
-    static decimal(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is People's Republic of China identity card
-     *
-     * 是否为中华人民共和国居民身份证
-     */
-    static idCard(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is china mobile (China)
-     *
-     * 是否为手机号（中国）
-     */
-    static mobile(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is url address
-     *
-     * 是否URL地址
-     */
-    static url(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is IPv4 address (Support v4, v6)
-     *
-     * 是否IP4地址（支持v4、v6）
-     */
-    static ip(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is color
-     *
-     * 是否颜色代码值
-     */
-    static color(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Wheter is chinese
-     *
-     * 是否中文
-     */
-    static chinese(control: AbstractControl): ValidationErrors | null;
-}
+import { AbstractControl, ValidationErrors } from '@angular/forms';
+/**
+ * A set of validators for reactive forms
+ *
+ * 一套用于响应式表单的验证器
+ */
+export declare class _Validators {
+    /**
+     * Wheter is number
+     *
+     * 是否为数字
+     */
+    static num(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is integer
+     *
+     * 是否为整数
+     */
+    static int(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is decimal
+     *
+     * 是否为小数点数值
+     */
+    static decimal(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is People's Republic of China identity card
+     *
+     * 是否为中华人民共和国居民身份证
+     */
+    static idCard(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is china mobile (China)
+     *
+     * 是否为手机号（中国）
+     */
+    static mobile(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is url address
+     *
+     * 是否URL地址
+     */
+    static url(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is IPv4 address (Support v4, v6)
+     *
+     * 是否IP4地址（支持v4、v6）
+     */
+    static ip(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is color
+     *
+     * 是否颜色代码值
+     */
+    static color(control: AbstractControl): ValidationErrors | null;
+    /**
+     * Wheter is chinese
+     *
+     * 是否中文
+     */
+    static chinese(control: AbstractControl): ValidationErrors | null;
+}

package/format/currency.service.d.ts

@@ -1,38 +1,38 @@
-import { YunzaiConfigService } from '@yelon/util/config';
-import { CurrencyCNYOptions, CurrencyFormatOptions, CurrencyMegaOptions, CurrencyMegaResult } from './currency.types';
-import * as i0 from "@angular/core";
-export declare class CurrencyService {
-    private readonly locale;
-    private readonly defCurrencyCode;
-    private c;
-    private readonly currencyPipe;
-    constructor(cog: YunzaiConfigService);
-    /**
-     * Format a number with commas as thousands separators
-     *
-     * 格式化货币，用逗号将数字格式化为千位分隔符
-     * ```ts
-     * 10000 => `10,000`
-     * 10000.567 => `10,000.57`
-     * ```
-     */
-    format(value: number | string, options?: CurrencyFormatOptions): string;
-    /**
-     * Large number format filter
-     *
-     * 大数据格式化
-     * ```ts
-     * 1000 => { value: '1', unit: 'K', unitI18n: '千' }
-     * 12456 => { value: '12.46', unit: 'K', unitI18n: '千' }
-     * ```
-     */
-    mega(value: number | string, options?: CurrencyMegaOptions): CurrencyMegaResult;
-    /**
-     * Converted into RMB notation.
-     *
-     * 转化成人民币表示法
-     */
-    cny(value: number | string, options?: CurrencyCNYOptions): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CurrencyService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<CurrencyService>;
-}
+import { YunzaiConfigService } from '@yelon/util/config';
+import { CurrencyCNYOptions, CurrencyFormatOptions, CurrencyMegaOptions, CurrencyMegaResult } from './currency.types';
+import * as i0 from "@angular/core";
+export declare class CurrencyService {
+    private readonly locale;
+    private readonly defCurrencyCode;
+    private c;
+    private readonly currencyPipe;
+    constructor(cog: YunzaiConfigService);
+    /**
+     * Format a number with commas as thousands separators
+     *
+     * 格式化货币，用逗号将数字格式化为千位分隔符
+     * ```ts
+     * 10000 => `10,000`
+     * 10000.567 => `10,000.57`
+     * ```
+     */
+    format(value: number | string, options?: CurrencyFormatOptions): string;
+    /**
+     * Large number format filter
+     *
+     * 大数据格式化
+     * ```ts
+     * 1000 => { value: '1', unit: 'K', unitI18n: '千' }
+     * 12456 => { value: '12.46', unit: 'K', unitI18n: '千' }
+     * ```
+     */
+    mega(value: number | string, options?: CurrencyMegaOptions): CurrencyMegaResult;
+    /**
+     * Converted into RMB notation.
+     *
+     * 转化成人民币表示法
+     */
+    cny(value: number | string, options?: CurrencyCNYOptions): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CurrencyService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CurrencyService>;
+}

package/format/currency.types.d.ts

@@ -1,82 +1,82 @@
-export type CurrencyStartingUnit = 'yuan' | 'cent';
-export interface CurrencyStartingUnitOptions {
-    /**
-     * The starting unit of the value, `yuan` means 元, `cent` means 分, default: `yuan`
-     *
-     * 值的起始单位，`yuan` 元，`cent` 分，默认：`yuan`
-     */
-    startingUnit?: CurrencyStartingUnit;
-}
-export interface CurrencyFormatOptions extends CurrencyStartingUnitOptions {
-    /**
-     * Using `DEFAULT_CURRENCY_CODE` when value is `true
-     *
-     * 是否使用 `CurrencyPipe` 来替代
-     */
-    useAngular?: boolean;
-    /**
-     * 精度，默认：`2`
-     */
-    precision?: number;
-    /**
-     * 是否忽略精度 `.0` 或 `.00` 结尾的字符，默认：`true`
-     */
-    ignoreZeroPrecision?: boolean;
-    /**
-     * Use anguar `currency` pipe parse when is set, pls refer to [document](https://angular.io/api/common/CurrencyPipe)
-     *
-     * 若指定则表示使用 Angular 自带的 `currency` 管道来解析，见[文档](https://angular.cn/api/common/CurrencyPipe)
-     */
-    ngCurrency?: {
-        display: 'code' | 'symbol' | 'symbol-narrow';
-        currencyCode?: string;
-        digitsInfo?: string;
-        locale?: string;
-    };
-}
-/**
- * Large number format filter, [Document](https://ng.yunzainfo.com/util/format/en#mega)
- *
- * 大数据格式化，[文档](https://ng.yunzainfo.com/util/format/en#mega)
- */
-export interface CurrencyMegaOptions extends CurrencyStartingUnitOptions {
-    /**
-     * 精度，默认：`2`
-     */
-    precision?: number;
-    /**
-     * 单位国际化，默认：`{Q: '京', T: '兆', B: '亿', M: '万', K: '千',}`
-     */
-    unitI18n?: CurrencyMegaUnitI18n;
-}
-export interface CurrencyMegaResult {
-    raw: number | string;
-    value: string;
-    unit: string;
-    unitI18n: string;
-}
-export declare const CurrencyMega_Powers: {
-    unit: string;
-    value: number;
-}[];
-export interface CurrencyMegaUnitI18n {
-    Q: string;
-    T: string;
-    B: string;
-    M: string;
-    K: string;
-}
-export interface CurrencyCNYOptions extends CurrencyStartingUnitOptions {
-    /**
-     * Whether to return to uppercase notation, default: `true`
-     *
-     * 是否返回大写表示法，默认：`true`
-     */
-    inWords?: boolean;
-    /**
-     * Specify negative sign, default: `negative`
-     *
-     * 指定负数符号，默认：`负`
-     */
-    minusSymbol?: string;
-}
+export type CurrencyStartingUnit = 'yuan' | 'cent';
+export interface CurrencyStartingUnitOptions {
+    /**
+     * The starting unit of the value, `yuan` means 元, `cent` means 分, default: `yuan`
+     *
+     * 值的起始单位，`yuan` 元，`cent` 分，默认：`yuan`
+     */
+    startingUnit?: CurrencyStartingUnit;
+}
+export interface CurrencyFormatOptions extends CurrencyStartingUnitOptions {
+    /**
+     * Using `DEFAULT_CURRENCY_CODE` when value is `true
+     *
+     * 是否使用 `CurrencyPipe` 来替代
+     */
+    useAngular?: boolean;
+    /**
+     * 精度，默认：`2`
+     */
+    precision?: number;
+    /**
+     * 是否忽略精度 `.0` 或 `.00` 结尾的字符，默认：`true`
+     */
+    ignoreZeroPrecision?: boolean;
+    /**
+     * Use anguar `currency` pipe parse when is set, pls refer to [document](https://angular.io/api/common/CurrencyPipe)
+     *
+     * 若指定则表示使用 Angular 自带的 `currency` 管道来解析，见[文档](https://angular.cn/api/common/CurrencyPipe)
+     */
+    ngCurrency?: {
+        display: 'code' | 'symbol' | 'symbol-narrow';
+        currencyCode?: string;
+        digitsInfo?: string;
+        locale?: string;
+    };
+}
+/**
+ * Large number format filter, [Document](https://ng.yunzainfo.com/util/format/en#mega)
+ *
+ * 大数据格式化，[文档](https://ng.yunzainfo.com/util/format/en#mega)
+ */
+export interface CurrencyMegaOptions extends CurrencyStartingUnitOptions {
+    /**
+     * 精度，默认：`2`
+     */
+    precision?: number;
+    /**
+     * 单位国际化，默认：`{Q: '京', T: '兆', B: '亿', M: '万', K: '千',}`
+     */
+    unitI18n?: CurrencyMegaUnitI18n;
+}
+export interface CurrencyMegaResult {
+    raw: number | string;
+    value: string;
+    unit: string;
+    unitI18n: string;
+}
+export declare const CurrencyMega_Powers: {
+    unit: string;
+    value: number;
+}[];
+export interface CurrencyMegaUnitI18n {
+    Q: string;
+    T: string;
+    B: string;
+    M: string;
+    K: string;
+}
+export interface CurrencyCNYOptions extends CurrencyStartingUnitOptions {
+    /**
+     * Whether to return to uppercase notation, default: `true`
+     *
+     * 是否返回大写表示法，默认：`true`
+     */
+    inWords?: boolean;
+    /**
+     * Specify negative sign, default: `negative`
+     *
+     * 指定负数符号，默认：`负`
+     */
+    minusSymbol?: string;
+}

package/format/index.d.ts

@@ -1,4 +1,4 @@
-export * from './string';
-export * from './validate';
-export * from './currency.service';
-export * from './currency.types';
+export * from './string';
+export * from './validate';
+export * from './currency.service';
+export * from './currency.types';

package/format/string.d.ts

@@ -1,44 +1,44 @@
-import type { NzSafeAny } from 'ng-zorro-antd/core/types';
-/**
- * String formatting
- *
- * 字符串格式化
- * ```
- * format('this is ${name}', { name: 'asdf' })
- * // output: this is asdf
- * format('this is ${user.name}', { user: { name: 'asdf' } }, true)
- * // output: this is asdf
- * ```
- */
-export declare function format(str: string | null | undefined, obj: NzSafeAny | null | undefined, needDeepGet?: boolean): string;
-export interface FormatMaskOption {
-    mask: string;
-    tokens?: {
-        [key: string]: FormatMaskToken;
-    };
-}
-export interface FormatMaskToken {
-    pattern: RegExp;
-    default?: NzSafeAny;
-    transform?: (char: string) => string;
-}
-/**
- * Format mask
- *
- * 格式化掩码
- *
- * | 字符 | 描述 |
- * | --- | --- |
- * | `0` | 任意数字，若该位置字符不符合，则默认为 `0` 填充 |
- * | `9` | 任意数字 |
- * | `#` | 任意字符 |
- * | `U` | 转换大写 |
- * | `L` | 转换小写 |
- * | `*` | 转换为 `*` 字符 |
- *
- * ```ts
- * formatMask('123', '(###)') => (123)
- * formatMask('15900000000', '999****9999') => 159****0000
- * ```
- */
-export declare function formatMask(value: string, option: string | FormatMaskOption): string;
+import type { NzSafeAny } from 'ng-zorro-antd/core/types';
+/**
+ * String formatting
+ *
+ * 字符串格式化
+ * ```
+ * format('this is ${name}', { name: 'asdf' })
+ * // output: this is asdf
+ * format('this is ${user.name}', { user: { name: 'asdf' } }, true)
+ * // output: this is asdf
+ * ```
+ */
+export declare function format(str: string | null | undefined, obj: NzSafeAny | null | undefined, needDeepGet?: boolean): string;
+export interface FormatMaskOption {
+    mask: string;
+    tokens?: {
+        [key: string]: FormatMaskToken;
+    };
+}
+export interface FormatMaskToken {
+    pattern: RegExp;
+    default?: NzSafeAny;
+    transform?: (char: string) => string;
+}
+/**
+ * Format mask
+ *
+ * 格式化掩码
+ *
+ * | 字符 | 描述 |
+ * | --- | --- |
+ * | `0` | 任意数字，若该位置字符不符合，则默认为 `0` 填充 |
+ * | `9` | 任意数字 |
+ * | `#` | 任意字符 |
+ * | `U` | 转换大写 |
+ * | `L` | 转换小写 |
+ * | `*` | 转换为 `*` 字符 |
+ *
+ * ```ts
+ * formatMask('123', '(###)') => (123)
+ * formatMask('15900000000', '999****9999') => 159****0000
+ * ```
+ */
+export declare function formatMask(value: string, option: string | FormatMaskOption): string;

package/format/validate.d.ts

@@ -1,72 +1,72 @@
-export declare const REGEX_STR: {
-    num: string;
-    idCard: string;
-    mobile: string;
-    url: string;
-    ip: string;
-    color: string;
-    chinese: string;
-};
-export declare const REGEX: {
-    num: RegExp;
-    idCard: RegExp;
-    mobile: RegExp;
-    url: RegExp;
-    ip: RegExp;
-    color: RegExp;
-    chinese: RegExp;
-};
-/**
- * Wheter is number
- *
- * 是否为数字
- */
-export declare function isNum(value: string | number): boolean;
-/**
- * Wheter is integer
- *
- * 是否为整数
- */
-export declare function isInt(value: string | number): boolean;
-/**
- * Wheter is decimal
- *
- * 是否为小数点数值
- */
-export declare function isDecimal(value: string | number): boolean;
-/**
- * Wheter is People's Republic of China identity card
- *
- * 是否为中华人民共和国居民身份证
- */
-export declare function isIdCard(value: string): boolean;
-/**
- * Wheter is china mobile (China)
- *
- * 是否为手机号（中国）
- */
-export declare function isMobile(value: string): boolean;
-/**
- * Wheter is url address
- *
- * 是否URL地址
- */
-export declare function isUrl(url: string): boolean;
-/**
- * Wheter is IPv4 address (Support v4, v6)
- *
- * 是否IP4地址（支持v4、v6）
- */
-export declare function isIp(ip: string): boolean;
-/**
- * Wheter is color
- *
- * 是否颜色代码值
- */
-export declare function isColor(color: string): boolean;
-/**
- * Wheter is chinese
- *
- * 是否中文
- */
-export declare function isChinese(value: string): boolean;
+export declare const REGEX_STR: {
+    num: string;
+    idCard: string;
+    mobile: string;
+    url: string;
+    ip: string;
+    color: string;
+    chinese: string;
+};
+export declare const REGEX: {
+    num: RegExp;
+    idCard: RegExp;
+    mobile: RegExp;
+    url: RegExp;
+    ip: RegExp;
+    color: RegExp;
+    chinese: RegExp;
+};
+/**
+ * Wheter is number
+ *
+ * 是否为数字
+ */
+export declare function isNum(value: string | number): boolean;
+/**
+ * Wheter is integer
+ *
+ * 是否为整数
+ */
+export declare function isInt(value: string | number): boolean;
+/**
+ * Wheter is decimal
+ *
+ * 是否为小数点数值
+ */
+export declare function isDecimal(value: string | number): boolean;
+/**
+ * Wheter is People's Republic of China identity card
+ *
+ * 是否为中华人民共和国居民身份证
+ */
+export declare function isIdCard(value: string): boolean;
+/**
+ * Wheter is china mobile (China)
+ *
+ * 是否为手机号（中国）
+ */
+export declare function isMobile(value: string): boolean;
+/**
+ * Wheter is url address
+ *
+ * 是否URL地址
+ */
+export declare function isUrl(url: string): boolean;
+/**
+ * Wheter is IPv4 address (Support v4, v6)
+ *
+ * 是否IP4地址（支持v4、v6）
+ */
+export declare function isIp(ip: string): boolean;
+/**
+ * Wheter is color
+ *
+ * 是否颜色代码值
+ */
+export declare function isColor(color: string): boolean;
+/**
+ * Wheter is chinese
+ *
+ * 是否中文
+ */
+export declare function isChinese(value: string): boolean;

package/index.d.ts

@@ -1,13 +1,13 @@
-export * from '@yelon/util/array';
-export * from '@yelon/util/browser';
-export * from '@yelon/util/config';
-export * from '@yelon/util/date-time';
-export * from '@yelon/util/form';
-export * from '@yelon/util/format';
-export * from '@yelon/util/math';
-export * from '@yelon/util/decorator';
-export * from '@yelon/util/other';
-export * from '@yelon/util/pipes';
-export * from '@yelon/util/token';
-export * from '@yelon/util/mtypes';
-export * from '@yelon/util/mcache';
+export * from '@yelon/util/array';
+export * from '@yelon/util/browser';
+export * from '@yelon/util/config';
+export * from '@yelon/util/date-time';
+export * from '@yelon/util/form';
+export * from '@yelon/util/format';
+export * from '@yelon/util/math';
+export * from '@yelon/util/decorator';
+export * from '@yelon/util/other';
+export * from '@yelon/util/pipes';
+export * from '@yelon/util/token';
+export * from '@yelon/util/mtypes';
+export * from '@yelon/util/mcache';

package/math/in-range.d.ts

@@ -1,14 +1,14 @@
-/**
- * Checks if `value` is between `start` and `end` to, but not including `end`. If `end` is not specified, it's set to start with `start` then set to `0`. If `start` is greater than `end` the params are swapped to support negative ranges.
- *
- * 检查 `value` 是否在 `start` 与 `end` 之间，但不包括 `end`。 如果 `end` 没有指定，那么 `start` 设置为 `0`。 如果 `start` 大于 `end`，那么参数会交换以便支持负范围。
- * ```ts
- * inRange(3, 2, 4); // true
- * inRange(4, 8); // true
- * inRange(4, 2); // false
- * inRange(2, 2); // false
- * inRange(1.2, 2); // true
- * inRange(-3, -2, -6); // true
- * ```
- */
-export declare function inRange(value: number, start: number, end?: number): boolean;
+/**
+ * Checks if `value` is between `start` and `end` to, but not including `end`. If `end` is not specified, it's set to start with `start` then set to `0`. If `start` is greater than `end` the params are swapped to support negative ranges.
+ *
+ * 检查 `value` 是否在 `start` 与 `end` 之间，但不包括 `end`。 如果 `end` 没有指定，那么 `start` 设置为 `0`。 如果 `start` 大于 `end`，那么参数会交换以便支持负范围。
+ * ```ts
+ * inRange(3, 2, 4); // true
+ * inRange(4, 8); // true
+ * inRange(4, 2); // false
+ * inRange(2, 2); // false
+ * inRange(1.2, 2); // true
+ * inRange(-3, -2, -6); // true
+ * ```
+ */
+export declare function inRange(value: number, start: number, end?: number): boolean;

package/math/index.d.ts

@@ -1,2 +1,2 @@
-export * from './in-range';
-export * from './round';
+export * from './in-range';
+export * from './round';