Editor Services

The core library also contains features allowing it to serve as a backend of a JSONPath editor. They can be used like this:

import { defaultQueryOptions, EditorService, TextChange, TextRange } from "@jsonpath-tools/jsonpath";

const editorService = new EditorService();

// Initial synchronization.
editorService.updateQuery("$.books[?@.author != null]");
editorService.updateQueryOptions(defaultQueryOptions);
editorService.updateQueryArgument(queryArgument);
editorService.updateQueryArgumentType(queryArgumentType);

// Get diagnostics.
const diagnostics = editorService.getDiagnostics();

// Write a dot.
editorService.updateQueryPartial([new TextChange(new TextRange(26, 0), ".")]);

// Get completions after the dot position.
const completionItems = editorService.getCompletions(27);

// ...