【JSリファレンス】Symbol.search

更新日：2024/06/14

Symbol.searchは、Symbolコンストラクターのプロパティです。

既知シンボル(well-known symbol) @@search の実体を返します。
オブジェクトのプロパティ名として既知シンボルを使用すると、そのプロパティが一部の組み込みメソッドまたは演算子から参照されます。

[Symbol.search]プロパティは、String.prototype.search()によって呼び出されます。

プロパティの値として次の関数が想定されます。

文字列を受け取り、何らかの値を返す関数

String.prototype.search()は文字列を正規表現で検索して、マッチした位置を返すメソッドです。
そのため、独自に作成したオブジェクトの[Symbol.search]()メソッドも同様の結果を返すことが期待されます。

実際には[Symbol.search]()メソッドは、任意の値を返すことができます。
※String.prototype.search()は戻り値のチェックを行いません。

■使用例

const obj = {
    [Symbol.search]: function(text) {
        return text + "は一致しないかもしれません";
    }
};

console.log( "abc".search(obj) ); // abcは一致しないかもしれません

スポンサーリンク

記事の内容について

こんにちはけーちゃんです。
説明するのって難しいですね。

「なんか言ってることおかしくない？」
たぶん、こんなご意見あると思います。

裏付けを取りながら記事を作成していますが、僕の勘違いだったり、そもそも情報源の内容が間違えていたりで、正確でないことが多いと思います。
そんなときは、ご意見もらえたら嬉しいです。

掲載コードについては事前に動作確認をしていますが、貼り付け後に体裁を整えるなどをした結果動作しないものになっていることがあります。
生暖かい視線でスルーするか、ご指摘ください。

ご意見、ご指摘はこちら。
https://jsref.affi-sapo-sv.com/info.php

 

このサイトは、リンクフリーです。大歓迎です。