json-p3/dist/path/types.d.ts

JSONPath, JSON Pointer and JSON Patch

import { JSONValue } from "../types";
import { JSONPathEnvironment } from "./environment";
export declare const Nothing: unique symbol;
/**
 * ValueType for JSONPath function expression tye system.
 */
export type JSONPathValue = JSONValue | typeof Nothing;
/**
 * Object passed to `FilterExpression.evaluate()`.
 */
export type FilterContext = {
    environment: JSONPathEnvironment;
    currentValue: JSONValue;
    rootValue: JSONValue;
    lazy?: boolean;
    currentKey?: string | number;
};
/**
 * A type predicate for an object with a string property.
 */
export declare function hasStringKey(value: unknown, key: string): value is {
    [key: string]: unknown;
};
export declare const KEY_MARK = "\u0002";
/**
 * Options for serializing paths.
 */
export type SerializationOptions = {
    /**
     * `pretty` paths always use:
     *  - shorthand notation rather than dot notation where possible
     *  - double quotes rather than single quotes for string literals and where shorthand
     *    notation is not possible
     *  - short escape sequences for common non-printing characters such as `\n` and `\t`
     *
     * `canonical` paths always use:
     *  - bracket notation for name and wildcard selectors
     *  - single quotes for name selectors and string literals
     *  - short escape sequences for common non-printing characters such as `\n` and `\t`
     *
     * `canonical` paths will produce a normalized path where available, but cannot be
     * considered normalized paths if the query does not represent a singular, absolute node.
     */
    form: "pretty" | "canonical";
};
export declare const defaultSerializationOptions: SerializationOptions;