（開発依存関係のライセンスも参照してください：licenses for dev. deps.）

JSONPath Plus

JSONドキュメント（およびJavaScriptオブジェクト）からデータを分析、変換、選択的に抽出します。

jsonpath-plus は元の仕様を拡張し、いくつかの追加演算子を加え、元の仕様が明確にしていなかった動作を明示します。

ブラウザデモまたは Runkit (Node) をお試しください。

注意：このプロジェクトは現在積極的にはメンテナンスされていません。十分に文書化されたPRや簡単な更新は受け付ける場合がありますが、修正や新機能の追加を自ら行う予定はありません。

特徴

元のjsonpath仕様に準拠
元の仕様にはない便利な追加・拡張：
- 一致した項目の親を取得するための ^
- 一致した項目のプロパティ名を（配列として）取得するための ~
- 以下を取得するための型セレクター：
  - 基本的なJSON型：@null()、@boolean()、@number()、@string()、@array()、@object()
  - @integer()
  - 複合型 @scalar()（JavaScriptオブジェクトをクエリする際には undefined や非有限数も受け入れ、基本的な非オブジェクト・非関数型もすべて受け入れます）
  - ユーザー定義の otherTypeCallback と組み合わせて使用できる @other()

ベンチマーク

jsonpath-plus は、json-querying-performance-testing によると、他のJSONクエリライブラリと比較して、大規模および小規模のデータセットの両方で一貫して高性能です。これらの結果は、プロジェクトを自分で実行して、さらにパフォーマンスケースを追加することで検証できます。

インストール```shell

npm install jsonpath-plus

## セットアップ

### Node.js```js
const {JSONPath} = require('jsonpath-plus');

const result = JSONPath({path: '...', json});

Browser

ブラウザで使用する場合は、dist/index-browser-umd.cjs を直接インクルードできます。Browserify の仕掛けは不要です。```html

### ESM（モダンブラウザ）

ES6 モジュールのインポート（モダンブラウザ向け）を使用することもできます：```html
<script type="module">

import {
    JSONPath
} from './node_modules/jsonpath-plus/dist/index-browser-esm.js';

const result = JSONPath({path: '...', json: {}});

</script>

ESM（バンドラー）

JavaScriptをバンドルしている場合（例：Rollupを使用）、単に次を使用してください。 mainFields には、ブラウザビルド用にbrowserを含める必要があることに注意してください（Nodeの場合は、moduleをチェックするデフォルトで問題ありません）：```js import {JSONPath} from 'jsonpath-plus';

const result = JSONPath({path: '...', json});

## 使用方法

利用可能な完全なシグネチャは次のとおりです:```
const result = JSONPath([options,] path, json, callback, otherTypeCallback);

引数 path、json、callback、および otherTypeCallback は、options 上で（利用可能な他のプロパティとともに）代替的に表現することもできます。

result には見つかったすべてのアイテムが含まれる（オプションで配列にラップされる）のに対し、callback は各アイテムが発見されるたびに何らかの操作を実行したい場合に使用でき、コールバック関数は結果内で見つかる独立したアイテムの数に応じて 0 回から N 回実行されます。 JSONPath の利用可能な引数の詳細については、以下のドキュメントを参照してください。

API ドキュメントも参照してください。

プロパティ

options オブジェクトまたは evaluate メソッド（最初の引数として）で指定できるプロパティには、以下が含まれます：

path (必須) - (正規化または非正規化された) 文字列または配列としての JSONPath 式
json (必須) - 評価する JSON オブジェクト（null、boolean、number、string、object、array 型のいずれか）。
autostart (デフォルト: true) - これが false として指定された場合、 evaluate メソッドを手動で呼び出すことができます。
flatten (デフォルト: false) - 返される結果の配列が単一の次元の配列にフラット化されるかどうか。
resultType (デフォルト: "value") - "value"、"path"、"pointer"、"parent"、または "parentProperty" の大文字小文字を区別しない形式を指定でき、それぞれ結果を検出されたアイテムの値として返すか、その絶対パスとして返すか、絶対パスへの JSON Pointer として返すか、その親オブジェクトとして返すか、またはその親のプロパティ名として返すかを決定します。 "all" に設定すると、これらの型すべてが型をキー名とするオブジェクトで返されます。
sandbox (デフォルト: {}) - フィルタリング式などのコード評価で利用可能な変数のキーと値のマップ。(現在のパスと値もそれらの式で利用可能になることに注意してください。詳細は構文セクションを参照してください。)
wrap (デフォルト: true) - 結果を配列でラップするかどうか。wrap が false に設定され、結果が見つからない場合、undefined が返されます（wrap が true に設定されている場合の空の配列とは対照的です）。wrap が false に設定され、単一の非配列の結果が見つかった場合、その結果が唯一の返されるアイテムになります（配列内ではありません）。ただし、複数の結果が見つかった場合は、依然として配列が返されます。曖昧さを避けるため（失敗である結果と空の配列である結果を区別する必要がある場合）、デフォルトをに切り替えることをお勧めします。

インスタンスメソッド

evaluate(path, json, callback, otherTypeCallback) または evaluate({path: <path>, json: <json object>, callback: <callback function>, otherTypeCallback: <otherTypeCallback function>}) - このメソッドは、 autostart プロパティが false に設定されている場合にのみ必要です。同じ設定を使用した繰り返しの評価に使用できます。リストされたプロパティに加えて、後者のメソッドパターンは、他の許可されたインスタンスプロパティのいずれも受け入れることができます（ここでは関連性のない autostart を除く）。

クラスのプロパティとメソッド

JSONPath.clearCache() - 内部でキャッシュされた解析済みパスとコンパイル済みスクリプトをクリアします。キャッシュの内容は公開されません。キャッシュの無効化が必要な場合は、このメソッドを呼び出してください。
JSONPath.toPathArray(pathAsString) - 正規化または非正規化されたパスを文字列として受け入れ、配列に変換します。例: ['$', 'aProperty', 'anotherProperty']。
JSONPath.toPathString(pathAsArray) - パス配列を受け入れ、正規化されたパス文字列に変換します。文字列は次のような形式になります: $['aProperty']['anotherProperty][0]。JSONPath の終端構文 ~ と ^、および @string() のような型演算子は静かに削除されます。
JSONPath.toPointer(pathAsArray) - パス配列を受け入れ、JSON Pointer に変換します。文字列は次のような形式になります: /aProperty/anotherProperty/0 （内部の ~ と / 文字は JSON Pointer 仕様に従ってエスケープされます）。JSONPath の終端構文 ~ と ^、および @string() のような型演算子は静かに削除されます。

例による構文

http://goessner.net/articles/JsonPath/ から取得した次の JSON を前提とします：```json { "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 }, { "category": "fiction", "author": "Herman Melville", "title": "Moby Dick", "isbn": "0-553-21311-3", "price": 8.99 }, { "category": "fiction", "author": "J. R. R. Tolkien", "title": "The Lord of the Rings", "isbn": "0-395-19395-8", "price": 22.99 } ], "bicycle": { "color": "red", "price": 19.95 } } }

and the following XML representation:```xml
<store>
    <book>
        <category>reference</category>
        <author>Nigel Rees</author>
        <title>Sayings of the Century</title>
        <price>8.95</price>
    </book>
    <book>
        <category>fiction</category>
        <author>Evelyn Waugh</author>
        <title>Sword of Honour</title>
        <price>12.99</price>
    </book>
    <book>
        <category>fiction</category>
        <author>Herman Melville</author>
        <title>Moby Dick</title>
        <isbn>0-553-21311-3</isbn>
        <price>8.99</price>
    </book>
    <book>
        <category>fiction</category>
        <author>J. R. R. Tolkien</author>
        <title>The Lord of the Rings</title>
        <isbn>0-395-19395-8</isbn>
        <price>22.99</price>
    </book>
    <bicycle>
        <color>red</color>
        <price>19.95</price>
    </bicycle>
</store>

以下のXPathの例では、要素とそのテキストコンテンツの取得を（比較に役立つ場合や曖昧さを避ける場合を除いて）区別していないことに注意してください。なお、XPathの例（2.0のものも含む）をテストするには、このデモが役立つかもしれません（xmlまたはxml-strictに設定してください）。| XPath | JSONPath | 結果 | 備考 | |-------------------------------------------------------------------------------------|---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | /store/book/author | $.store.book[*].author | ストア内のすべての本の著者 | を付けずにと表記することも可能（ただし、これは元の仕様には存在しない）。一部の文字リテラル（と）はエスケープが必要な点に注意 | | | | すべての著者 | | | | | ストア内のすべてのもの。つまり、その本（本の配列）と赤い自転車（自転車オブジェクト）。 | | | | | ストア内のすべてのものの価格。 | | | | | 3番目の本（本オブジェクト） | | | | | 順序における最後の本。 | 特殊文字を含むプロパティにアクセスするには、フィルタにを利用する（この特定の機能は元の仕様には存在しない） | | | | 最初の2冊の本 | | | または XPath 2.0 の | | すべての本のカテゴリと著者 | | | | | ISBN番号を持つすべての本をフィルタリング | 特殊文字を含むプロパティにアクセスするには、フィルタにを利用する（この特定の機能は元の仕様には存在しない） | | | | 10より安いすべての本をフィルタリング | | | | | プロパティが price であり、かつ 8.95 と等しくないオブジェクトのすべてのプロパティ値を取得 | 裸のを使用すると、プロパティ値によってオブジェクトをフィルタリングできる（必ずしも配列内である必要はない）。式の後にを追加すると、フィルタリングされたプロパティを持つオブジェクトを取得できる | | | | JSONオブジェクトのルート（つまり、オブジェクト自体全体） | リテラルの（単独またはパス内のどこでも）を取得するには、バッククォートエスケープを使用する必要がある | | | | XMLドキュメントのルート以下のすべての要素（およびテキスト）。JSON構造のルート以下のすべてのメンバー。 | | | | | XMLドキュメント内のすべての要素。ルートを含むJSON構造のすべての親コンポーネント。 | この動作は元の仕様では直接指定されていなかった | | | | 価格が19より大きい特定のアイテムの親（つまり、自転車の親としてのストア値、および個々の本の親としての本の配列） | 親（キャレット）は元の仕様には存在しない | | (XPath 2.0) | | ストアサブオブジェクトのプロパティ名（"book" と "bicycle"）。ワイルドカードプロパティで有用。 | プロパティ名（チルダ）は元の仕様には存在しない | | (XPath 2.0) | | 最初の本を指すパスにある本以外のすべての本 | は元の仕様には存在しない | | | | 本の親オブジェクトが、色が赤である自転車の子を持つ本のすべてのカテゴリを取得（つまり、すべての本） | は元の仕様には存在しない | | | | "book" のすべての子のうち、"category" のものを除いて取得 | は元の仕様には存在しない | | | | プロパティ（配列内に入るため数値インデックスとなる）が0ではないすべての本を取得 | は元の仕様には存在しない | | | | 親プロパティが book ではないストアの孫を取得（つまり、自転車の子、"color" と "price"） | は元の仕様には存在しない | | | | これらの値の親プロパティ（つまり、本アイテムの親オブジェクトを保持する配列インデックス）が0ではない、すべての本インスタンスのプロパティ値を取得 | は元の仕様には存在しない | | | | 価格が3番目の本の価格と等しいすべての本をフィルタリング | は元の仕様には存在しない | | (XPath 2.0) | | 本の配列内の数値を取得 | 、その他の基本型（、）、その他の低レベル派生型（、、）、JSONSchema で追加された型、複合型（JavaScript オブジェクトのと非有限数、および基本的な非オブジェクト/非関数型のすべても受け入れる）、ユーザー定義コールバックと組み合わせて使用する型（を参照）、および JSONPath で非 JSON の JavaScript オブジェクトをクエリする際に使用できる以下の非 JSON 型（、、）は元の仕様には存在しない | | (XPath 2.0) | | 正規表現に一致する（大文字小文字を区別せず 'TION' で終わる）すべての本のカテゴリ | は元の仕様には存在しない。 | | (XPath 2.0) | | 正規表現に一致するプロパティを持つすべての本（大文字小文字を区別せず 'TION' で終わる） | は元の仕様には存在しない。注: 式の最後に親セレクタを使用して親オブジェクトに戻る。親セレクタがない場合、2つのキー値に一致する。 | | | (例: でリテラルにという名前のプロパティに一致) | 後続のシーケンス全体をエスケープする（リテラルとして扱う） | は元の仕様には存在しない。リテラルのバッククォートを取得するには、追加のバッククォートでエスケープする | を使用してアクセスします。

アイデア

フィルターの外側での OR（XPath の | のような）とグループ化のサポート。
XPath フィルターのように子を選択しない動作をする構文の作成。
parentNode 相当のオプションの許可（ルートまでの parent-and-parentProperty オブジェクトのチェーン全体を維持）。

開発

Node でテストを実行する場合:```shell npm test

ブラウザ内テストの場合:

- js/htmlファイルを配信します:```shell
npm run browser-test

http://localhost:8082/test/ にアクセスしてください。

セキュリティ

重要なセキュリティ上の考慮事項と脆弱性の報告方法については、SECURITY.md を参照してください。

ライセンス

MITライセンス。

JSONPath

人気