botbook/node_modules/@sagold/json-query/dist/lib/get.d.ts

24 lines
749 B
TypeScript
Raw Normal View History

2024-09-04 13:13:15 -03:00
import { Input, JsonPointer } from "./types";
export declare enum ReturnType {
POINTER = "pointer",
VALUE = "value",
ALL = "all",
MAP = "map"
}
export type ResultCallback = (value: any, property: string | null, parent: {
[p: string]: any;
} | Array<any> | null, pointer: JsonPointer) => any;
/**
* Runs query on input data and returns the results
* @param data - input data
* @param queryString - json-query string
* @param returnType - result format or a custom callback
*/
export declare function get(data: Input, queryString: string, returnType?: ReturnType | ResultCallback): any;
export declare namespace get {
var POINTER: ReturnType;
var VALUE: ReturnType;
var ALL: ReturnType;
var MAP: ReturnType;
}