【TypeScript】Arrayをソートする拡張メソッドの実装 - その３

概要

下記の記事でArrayソート用の拡張メソッドを実装しました。

kakkoyakakko2.hatenablog.com

今回は、ファンクションで変換した値でのソートに対応しようと思います。

動作環境

TypeScript 2.9.x

サンプルソース

export {};

/** ソート情報 */
type SortInfo<T, K> = {
  /** ソートキー */
  sortKey?: K,
  /** ソートコールバック */
  sortFn?: (obj: T) => any,
  /** 昇順フラグ */
  asc: boolean
};

declare global {
  interface Array<T> {
    /**
     * [拡張メソッド]
     * 指定したプロパティを元に昇順にソートします。
     * @param sortKeys 昇順キー
     * @return ソート後の配列
     */
    orderBy<K extends keyof T>(...sortKeys: K[]): T[];

    /**
     * [拡張メソッド]
     * 指定したプロパティを元にソートします。
     * @param sortKeys sortKey:ソートキー, asc: 昇順フラグ, sortFn: ソート項目
     * @return ソート後の配列
     */
    orderBy<K extends keyof T>(...sortKeys: { sortKey?: K, asc: boolean, sortFn?: (obj: T) => any}[]): T[];
  }
}

Array.prototype.orderBy = function<T, K extends keyof T>(...sortKeys: any[]): T[] {
  const items = this as T[];

  if (!Array.isArray(sortKeys) || sortKeys.length === 0)
    return items.sort();
  else {
    let sortInfos: SortInfo<T, K>[];
    if (typeof sortKeys[0] === 'object')
      sortInfos = sortKeys as SortInfo<T, K>[];
    else
      sortInfos = (<K[]>sortKeys).map(key => { return { sortKey: key, asc: true }; });
    return items.sort((a: T, b: T) => compare(a, b, sortInfos));
  }
};

/**
 * ソート判定処理
 * 再帰的にsortInfosを処理して、ソート判定を行います
 * @param value1
 * @param value2
 * @param sortInfos
 */
function compare<T, K extends keyof T>(value1: T, value2: T, sortInfos: SortInfo<T, K>[]): number {
  const info = sortInfos[0];
  const prop1 = (info.sortKey) ? value1[info.sortKey] : info.sortFn(value1);
  const prop2 = (info.sortKey) ? value2[info.sortKey] : info.sortFn(value2);

  if (prop1 !== prop2) {
    // 値が異なる場合は昇順フラグを元に大小判定
    if (info.asc)
      return (prop1 < prop2) ? -1 : 1;
    else
      return (prop1 > prop2) ? -1 : 1;
  } else {
    // 値が同じ場合はsortInfosが2つ以上残っている時は再帰処理
    if (sortInfos.length <= 1)
      return 0;
    else
      return compare(value1, value2, sortInfos.slice(1));
  }
}

SortInfo.sortFnに値を変換するファンクションを指定することで、変換後の値でソート処理をするようになります。

実行結果

const items = [ 
  { id: 2, name: 'bob' }, { id: 3, name: 'alex' }, { id: 1, name: 'char' }, { id: 4, name: 'bob' } 
];

const actual = items.orderBy({ sortFn: (d) => d.name, asc: true }, { sortKey: 'id', asc: false });
// output:  
// id: 3, name: 'alex'
// id: 4, name: 'bob'
// id: 2, name: 'bob'
// id: 1, name: 'char'