javascriptのunshiftメソッドをわかりやすく説明する
はじめに
javascriptのunshiftメソッドについて噛み砕いて説明します。
この記事を書いた人
@takasqr アプリケーション開発が大好きなエンジニア。Vue、Swift、Electrom などでアプリを作って公開している。AWS や Firebase などのクラウドサービスも好き。
unshiftメソッドとは何か
unshift
はjavascriptのメソッドです。
どのようなメソッドかというと、
- 配列の最初に要素を追加する
- 追加した後の配列の長さを返す
という特徴があります。
unshiftメソッドの書き方
unshiftメソッドは下のように書きます。
[配列].unshift([追加したい値1], [追加したい値1])
unshiftは配列の最初に追加する
配列とはひとまとまりのデータを一つの変数に格納するためのデータの型です。
const fruits = ['apple', 'banana', 'pear', 'melon', 'watermelon'];
のような感じで表現します。
unshiftメソッドは配列の最初に要素を追加します。
例えば、下のようなコードがあったとします。
const fruits = ['apple', 'banana', 'pear'];
console.log('unshiftメソッド実行前')
console.log(fruits);
fruits.unshift('watermelon', 'melon');
console.log('unshiftメソッド実行後')
console.log(fruits);
実行すると、
> "unshiftメソッド実行前"
> Array ["apple", "banana", "pear"]
> "unshiftメソッド実行後"
> Array ["watermelon", "melon", "apple", "banana", "pear"]
このように値が返ってくると思います。
"watermelon"
と"melon"
が増えていますね。
unshiftの戻り値について
戻り値とは、メソッドが実行された後に返される値のことです。
例えば、
const fruits = ['apple', 'banana', 'pear'];
const returnValue = fruits.unshift('watermelon', 'melon');
console.log(returnValue);
のような感じで書きます。
例ではunshiftメソッドの戻り値をreturnValue
に入れて、出力しています。
要素を追加した後の要素数である5
が出力されると思います。
> 5
unshiftの使い道
配列に値を追加する時に使うことができます。
さいごに
引数を設定しなくてもエラーにはなりませんが、配列には何も追加されません。
const fruits = ['apple', 'banana', 'pear'];
const returnValue = fruits.unshift();
console.log(returnValue);
> 3