ブログblog

lodashについて

Writer: tokuyasu 更新日:2024/05/30

こんにちは、デジナーレ福岡オフィスの徳安です。

 

今回は、プロジェクトでlodashを使用する機会があったので、
lodashについて調べた内容と、
今後活用できそうなメソッドを記事にまとめてみました。

lodashとは

Lodashとは、配列、数値、オブジェクト、文字列などの
操作をまとめて提供してくれるライブラリ。

配列、オブジェクト、文字列の反復処理
値の操作とテスト
複合関数の作成

などの操作で使用するのが最適。

使い方

インストール

インストール後に、使用するファイルでインポートして使用する。

 

Array(配列)

_.chunk(array, [size=1])

配列を引数の数で分割してくれるメソッド

_.compact(array)

配列の中から falsyな値 を全て排除してくれるメソッド

*falsyな値 (false、空文字、NaN、0、undefined、null)

_.difference(array, [values])

array  : 比較したい配列
values : 除外したい値

二つの配列を比較して、
第二引数(values)で指定された配列に含まれない値を、返却してくれるメソッド。
返却された配列の順序は、最初の配列の順列で決まる。

_.drop(array, [n=1])

先頭から[n=1]で指定した要素の数だけ削除
配列を作成してくれるメソッド。
n個指定しないと、先頭の1つだけ削除される。

array (配列) : 照会する配列
[n=1] (数値) : 削除する要素の数

 

_.dropRight(array, [n=1])

末尾から[n=1]で指定した要素の数だけ削除し、
配列を作成してくれるメソッド。
n個指定しないと、先頭の1つだけ削除される。

array (配列) : 照会する配列
[n=1] (数値) : 削除する要素の数

 _.flatten(array)

配列のネストを1つ浅くすることができるメソッド。

 

_.flattenDeep(array)

_.flattenDeepは配列のネストをなくして、全てフラットにすることができるメソッド。

 

_.fromPairs(pairs)

二つの配列のkey、valueからオブジェクトを生成してくれるメソッド。

pairs (配列) : キーと値のペア

_.union([arrays])

指定された配列から、一意の値の配列を順番に作成してくれるメソッド。

[arrays]  : 検査する配列

 

_.uniq(array)

配列から一意な値を取得してくれるメソッド。
結果値の順序は、配列内での出現順序によって決まる。

 

そのほかのメソッド

_.isEqual(value, other)


2 つの値を比較して、値が等しいかどうかを判断してくれるメソッド。

value  : 比較する値
other  : 比較するもう一方の値

_.uniqueId([prefix=''])

一意の ID を生成してくれるメソッド。
prefixが指定されている場合は、prefixの後にID が追加される。

 

_.castArray(value)

引数に入れた値を配列として返却してくれるメソッド。
配列が来た場合は、そのまま返却される。

value  : 検査する値

_.clone(value)

valueに入れた値を、1階層までコピーしてくれるメソッド。
シャローコピー

value  : 複製する値

_.cloneDeep(value)

valueに渡された値を再帰的にコピーしてくれるメソッド。
ディープコピー

value  : 再帰的に複製する値

lodashを使用することによって、

配列の操作、抽出、オブジェクトへの変換などが簡単にできます。

コードもすっきりし、可読性が上がるため、

プロジェクトで使用している場合は、効率よく組み込んでいきたいと思います。

 

ここまで読み進めていただきありがとうございます。