@digitalwalletcorp/utils 0.5.0 → 0.6.1

package/src/number-util.ts

@@ -419,6 +419,72 @@ export function toString(
   }
 }
 
+/** toNumber のオプション */
+export interface ToNumberOptions {
+  /** 未指定(null・undefined・空白のみの文字列)のときに返す値。デフォルトは 'null' */
+  empty?: 'null' | 'undefined' | 'zero';
+  /** 数値として解釈できない(結果が NaN になる)ときに返す値。デフォルトは 'NaN' */
+  nan?: 'NaN' | 'null' | 'undefined';
+}
+
+/** options.empty に応じた未指定時の戻り値の型。'zero' は number に含まれるので never */
+type EmptyResult<O extends ToNumberOptions> = O extends { empty?: infer E }
+  ? E extends 'undefined' ? undefined : E extends 'zero' ? never : null
+  : null;
+
+/** options.nan に応じた変換不可時の戻り値の型。'NaN' は number に含まれるので never */
+type NanResult<O extends ToNumberOptions> = O extends { nan?: infer N }
+  ? N extends 'null' ? null : N extends 'undefined' ? undefined : never
+  : never;
+
+/**
+ * 数値に変換する
+ * 文字列はカンマと前後の空白を除いてから変換する
+ * null・undefined・空白のみの文字列は未指定として扱い、options.empty に応じて null(デフォルト)・undefined・0 のいずれかを返す
+ * 数値として解釈できない場合は options.nan に応じて NaN(デフォルト)・null・undefined のいずれかを返す
+ *
+ * @param {NumberSource | null | undefined} value
+ * @param {ToNumberOptions} [options]
+ *   ├ empty 未指定のときに返す値。'null'(デフォルト) | 'undefined' | 'zero'
+ *   └ nan 数値として解釈できないときに返す値。'NaN'(デフォルト) | 'null' | 'undefined'
+ * @returns {number | EmptyResult<O> | NanResult<O>} 戻り値の型は options に連動する
+ */
+export function toNumber<O extends ToNumberOptions = Record<never, never>>(value: NumberSource | null | undefined, options?: O): number | EmptyResult<O> | NanResult<O> {
+  type Result = number | EmptyResult<O> | NanResult<O>;
+  if (value == null || isBlank(value)) {
+    switch (options?.empty) {
+      case 'undefined':
+        return undefined as Result;
+      case 'zero':
+        return 0;
+      default:
+        return null as Result;
+    }
+  }
+  let result: number;
+  switch (typeof value) {
+    case 'number':
+      result = value;
+      break;
+    case 'bigint':
+      result = Number(value);
+      break;
+    default:
+      result = Number(removeComma(value).trim());
+  }
+  if (Number.isNaN(result)) {
+    switch (options?.nan) {
+      case 'null':
+        return null as Result;
+      case 'undefined':
+        return undefined as Result;
+      default:
+        return result;
+    }
+  }
+  return result;
+}
+
 /**
  * 渡されたバイト数値を桁数に応じてMB,GBなどに単位を変更する
  *

package/src/object-util.ts

@@ -441,6 +441,45 @@ export function hashCode(value: any): number {
   return hash >>> 0;
 }
 
+/**
+ * 配列でない値を配列に包み、値が配列であることを保証する
+ * 配列はそのまま返し、それ以外の値は1要素の配列にする。null・undefined の扱いは options.nullish で指定する
+ *
+ * 主な用途は、1件なら単一の値、複数なら配列で届くリクエストパラメータ(クエリ文字列の同名パラメータなど)を配列に統一すること。
+ * 単一の値と配列の両方を受け付ける引数を配列に揃える場面であれば、ほかの用途にも使える
+ *
+ * @example
+ *   ensureArray('a');                             // ['a']
+ *   ensureArray(['a', 'b']);                      // ['a', 'b'] (同じ配列)
+ *   ensureArray(undefined);                       // [undefined]
+ *   ensureArray(undefined, { nullish: 'empty' }); // []
+ *   ensureArray(undefined, { nullish: 'keep' });  // undefined
+ *
+ * @param {T | T[] | null | undefined} value
+ * @param {*} [options]
+ *   └ nullish null・undefined を渡したときの扱い。デフォルトは 'wrap'
+ *       'wrap'  1要素の配列に包む([null] / [undefined])。lodash の castArray と同じ無損失の変換
+ *       'empty' 空配列にする。未指定を「要素なし」として扱うとき
+ *       'keep'  そのまま返す。未指定を区別したまま呼び出し側で扱うとき
+ * @returns {T[]} nullish が 'keep' の場合は null・undefined も返す
+ */
+export function ensureArray<T>(value: T | T[], options?: { nullish?: 'wrap' }): T[];
+export function ensureArray<T>(value: T | T[] | null | undefined, options: { nullish: 'empty' }): NonNullable<T>[];
+export function ensureArray<T>(value: T | T[] | null | undefined, options: { nullish: 'keep' }): NonNullable<T>[] | null | undefined;
+export function ensureArray<T>(value: T | T[] | null | undefined, options?: { nullish?: 'wrap' | 'empty' | 'keep' }): T[] | null | undefined {
+  if (value == null) {
+    switch (options?.nullish) {
+      case 'empty':
+        return [];
+      case 'keep':
+        return value as null | undefined;
+      default:
+        return [value as T];
+    }
+  }
+  return Array.isArray(value) ? value : [value];
+}
+
 /**
  * 配列から重複する要素を除いた新しい配列を返す
  * ・null / undefined の要素は除く

package/lib/number-util-BaSf1wWH.cjs

@@ -1,2 +0,0 @@
-"use strict";const i=require("./decimal.cjs"),C=new i.Decimal("-9223372036854775808"),V=new i.Decimal("9223372036854775807"),w=new RegExp("([+-]?)([0-9]*)[.]?([0-9]*)"),y=/^[+-]?(\d+\.?\d*|\.\d+)(e[+-]?\d+)?$/i,N=e=>typeof e=="string"&&e.trim()==="";function b(e,t){if(e==null||N(e))return!1;const n=Number.isFinite(t?.minValue)?new i.Decimal(t.minValue):C;try{return n.lte(e)&&V.gte(e)}catch{return!1}}function g(e,t,n){if(e==null||e==="")return"";let r;switch(typeof e){case"number":if(!Number.isFinite(e))return String(e);r=new i.Decimal(e).toString();break;case"string":if(r=s(e).trim(),!y.test(r))return e;/e/i.test(r)&&(r=`${r.startsWith("+")?"+":""}${new i.Decimal(r).toString()}`);break;default:r=e.toString()}const o=w.exec(r),l=o[1];let c=o[2]||"0",u=o[3],a,f=new i.Decimal(`${l==="-"?"-":""}${c}.${u}`);if(t!=null){f=f.round(t,n??i.ROUNDING_MODE.roundHalfUp);const d=w.exec(f.toString());c=d[2],u=d[3],a=t}else a=u.length;const D=f.eq(0)?"":l;return c=c.replace(/(\d)(?=(\d{3})+$)/g,"$1,"),u=`${u}${"0".repeat(a)}`.substring(0,a),u===""?`${D}${c}`:`${D}${c}.${u}`}function s(e){return e.replace(/,/g,"")}function $(e,t){return new Intl.NumberFormat(t,{notation:"compact"}).format(e)}function p(e,t,n){let r=new i.Decimal(e);for(const o of t)r=r[o.operator](o.value);return n?.scale!=null&&(r=r.round(n.scale,n.roundingMode??i.ROUNDING_MODE.roundHalfUp)),r.toNumber()}function S(e,...t){let n=new i.Decimal(e);for(const r of t)n=n.add(r);return n.toNumber()}function M(e,...t){let n=new i.Decimal(e);for(const r of t)n=n.sub(r);return n.toNumber()}function O(e,...t){let n=new i.Decimal(e);for(const r of t)n=n.times(r);return n.toNumber()}function U(e,...t){let n=new i.Decimal(e);for(const r of t)n=n.div(r);return n.toNumber()}function m(e,t){return new i.Decimal(e).compareTo(t)}function _(e,t){return m(e,t)===0}function h(e,t){return m(e,t)<0}function R(e,t){return m(e,t)<=0}function E(e,t){return 0<m(e,t)}function G(e,t){return 0<=m(e,t)}function I(e,t,n){if(e==null)return null;const r=n??i.ROUNDING_MODE.roundHalfUp;switch(typeof e){case"number":return Number.isFinite(e)?new i.Decimal(e).round(t,r).toNumber():e;case"string":{if(N(e))return null;try{return new i.Decimal(e).round(t,r).toNumber()}catch{return Number.NaN}}default:return new i.Decimal(e).round(t,r).toNumber()}}function T(e,t){if(e==null)return"";if(N(e)||typeof e=="number"&&!Number.isFinite(e))return String(e);try{const n=new i.Decimal(e);return t?.scale!=null?n.toFixed(t.scale,t.roundingMode??i.ROUNDING_MODE.roundHalfUp):n.toString()}catch{return String(e)}}function B(e,t){if(e==null||e==="")return[String(e),""];let n;switch(typeof e){case"number":if(Number.isNaN(e))return["NaN",""];n=new i.Decimal(e);break;case"string":try{n=new i.Decimal(s(e))}catch{return[e,""]}break;default:n=new i.Decimal(e)}const r=["B","KB","MB","GB","TB"];let o=0;for(;n.gte(1024)&&o<r.length-1;)n=n.div(1024),o++;const l=t?.scale??2,c=t?.roundingMode??i.ROUNDING_MODE.roundHalfUp;return t?.format?[g(n.toString(),l,c),r[o]]:[n.round(l,c).toString(),r[o]]}const F=Object.freeze(Object.defineProperty({__proto__:null,ROUNDING_MODE:i.ROUNDING_MODE,add:S,calc:p,compareTo:m,div:U,eq:_,formatBytes:B,formatComma:g,formatCompact:$,gt:E,gte:G,isLongValue:b,lt:h,lte:R,removeComma:s,round:I,sub:M,times:O,toString:T},Symbol.toStringTag,{value:"Module"}));exports.add=S;exports.calc=p;exports.compareTo=m;exports.div=U;exports.eq=_;exports.formatBytes=B;exports.formatComma=g;exports.formatCompact=$;exports.gt=E;exports.gte=G;exports.isLongValue=b;exports.lt=h;exports.lte=R;exports.numberUtil=F;exports.removeComma=s;exports.round=I;exports.sub=M;exports.times=O;exports.toString=T;
-//# sourceMappingURL=number-util-BaSf1wWH.cjs.map