【Node.js24.x】Object::stringify()メソッドの使い方
stringifyメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
stringifyメソッドは、Node.js環境で利用できるJSONオブジェクトが提供するメソッドです。このメソッドは、JavaScriptのデータ構造、例えばオブジェクト、配列、文字列、数値、真偽値、nullなどを、JSON（JavaScript Object Notation）形式の文字列に変換する役割を実行します。
データの保存や、異なるシステム間でのデータ交換において非常に重要な機能であり、特にウェブアプリケーションでサーバーとクライアント間で情報をやり取りする際に広く活用されます。例えば、JavaScriptのオブジェクトをHTTPリクエストのボディとして送信したり、ローカルストレージに保存したりする前に、このメソッドでJSON文字列に変換する必要があります。
具体的な動作として、JavaScriptのオブジェクトはキーと値が引用符で囲まれたJSONオブジェクトに、配列は要素がカンマで区切られたJSON配列に変換されます。文字列、数値、真偽値、nullといったプリミティブな値は、そのままJSONの対応する形式に変換されます。ただし、関数、Symbol、またはundefinedのプロパティは変換後のJSON文字列には含まれません。配列の要素としてundefinedや関数がある場合はnullに変換されます。
さらに、stringifyメソッドはオプション引数をサポートしています。第2引数であるreplacer関数を使用すると、変換するプロパティをフィルタリングしたり、その値を変更したりするカスタマイズが可能です。また、第3引数であるspaceを使用すると、生成されるJSON文字列にインデントや改行を追加して、人が読みやすいように整形することができます。これにより、デバッグ時などにデータ構造を把握しやすくなります。
構文(syntax)
1JSON.stringify({}, undefined, 2);
引数(parameters)
obj, sep = '&', eq = '=', options
- obj: object: 文字列に変換する対象のオブジェクト
- sep: string = '&': キーと値のペアを区切る文字列
- eq: string = '=': キーと値を区切る文字列
- options: object = null: 文字列化のオプションを指定するオブジェクト (詳細については公式ドキュメントを参照)
戻り値(return)
String
指定されたJavaScriptオブジェクトをJSON形式の文字列に変換した結果を返します。