Property Paths

Property path は、JSON、YAML、TOML、INI データのネストされたプロパティを取得・変更するための文字列です。Parser node でデータをパースした後、property path を使ってパース済みオブジェクトから値を取得・変更できます。Property Getter や Property Setter などの node は、ドット記法やブラケット記法を使って、ネストされたオブジェクトや配列内の値にアクセスしたり設定したりします。

property path の input を持つすべての node は、パスが無効な場合、型が一致しない場合、またはデータにそのプロパティが存在しない場合にエラーをスローしますのでご注意ください。

例

以下のシンプルな JSON を例にします:

{
    "user": {
        "name": "John Doe",
        ...
    }
}

name プロパティにアクセスするには、property path user.name を使います。ドット . はオブジェクトのプロパティを辿るために使用します。配列の要素にアクセスするには、ブラケット記法 [] にインデックスを指定します。

{
    "array": [
        "first",
        "second",
        ...
    ]
}

上記の配列の最初の要素にアクセスするには、ブラケット記法を使った property path array[0] を使います。