iframe-proxy | Sunbelt Computer Software

History

196 lines (183 loc) · 6.54 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

/**

* Declaration for https://github.com/s3u/JSONPath

declare module 'jsonpath-plus' {

type JSONPathCallback = (

payload: any, payloadType: any, fullPayload: any

) => any

type JSONPathOtherTypeCallback = (...args: any[]) => void

interface JSONPathOptions {

/**

* The JSONPath expression as a (normalized or unnormalized) string or

* array.

path: string | any[]

/**

* The JSON object to evaluate (whether of null, boolean, number,

* string, object, or array type).

/**

* If this is supplied as false, one may call the evaluate method

* manually.

* @default true

autostart?: true | boolean

/**

* Whether the returned array of results will be flattened to a

* single dimension array.

* @default false

flatten?: false | boolean

/**

* Can be case-insensitive form of "value", "path", "pointer", "parent",

* or "parentProperty" to determine respectively whether to return

* results as the values of the found items, as their absolute paths,

* as JSON Pointers to the absolute paths, as their parent objects,

* or as their parent's property name.

* If set to "all", all of these types will be returned on an object with

* the type as key name.

* @default 'value'

resultType?:

/**

* Key-value map of variables to be available to code evaluations such

* as filtering expressions.

* (Note that the current path and value will also be available to those

* expressions; see the Syntax section for details.)

sandbox?: Map<string, any>

/**

* Whether or not to wrap the results in an array.

* If wrap is set to false, and no results are found, undefined will be

* returned (as opposed to an empty array when wrap is set to true).

* If wrap is set to false and a single non-array result is found, that

* result will be the only item returned (not within an array).

* An array will still be returned if multiple results are found, however.

* To avoid ambiguities (in the case where it is necessary to distinguish

* between a result which is a failure and one which is an empty array),

* it is recommended to switch the default to false.

* @default true

wrap?: true | boolean

/**

* Although JavaScript evaluation expressions are allowed by default,

* for security reasons (if one is operating on untrusted user input,

* for example), one may wish to set this option to true to throw

* exceptions when these expressions are attempted.

* @default false

preventEval?: false | boolean

/**

* In the event that a query could be made to return the root node,

* this allows the parent of that root node to be returned within results.

* @default null

parent?: null | any

/**

* In the event that a query could be made to return the root node,

* this allows the parentProperty of that root node to be returned within

* results.

* @default null

parentProperty?: null | any

/**

* If supplied, a callback will be called immediately upon retrieval of

* an end point value.

* The three arguments supplied will be the value of the payload

* (according to `resultType`), the type of the payload (whether it is

* a normal "value" or a "property" name), and a full payload object

* (with all `resultType`s).

* @default undefined

callback?: undefined | JSONPathCallback

/**

* In the current absence of JSON Schema support,

* one can determine types beyond the built-in types by adding the

* perator `@other()` at the end of one's query.

* If such a path is encountered, the `otherTypeCallback` will be invoked

* with the value of the item, its path, its parent, and its parent's

* property name, and it should return a boolean indicating whether the

* supplied value belongs to the "other" type or not (or it may handle

* transformations and return false).

* @default undefined

* <A function that throws an error when `@other()` is encountered>

otherTypeCallback?: undefined | JSONPathOtherTypeCallback

}

interface JSONPathOptionsAutoStart extends JSONPathOptions {

autostart: false

}

interface JSONPathCallable {

<T = any>(options: JSONPathOptionsAutoStart): JSONPathClass

<T = any>(options: JSONPathOptions): T

<T = any>(

path: JSONPathOptions['path'],

json: JSONPathOptions['json'],

callback: JSONPathOptions['callback'],

otherTypeCallback: JSONPathOptions['otherTypeCallback']

): T

}

class JSONPathClass {

/**

* Exposes the cache object for those who wish to preserve and reuse

* it for optimization purposes.

static cache: any

/**

* Accepts a normalized or unnormalized path as string and

* converts to an array: for example,

* `['$', 'aProperty', 'anotherProperty']`.

static toPathArray(path: string): string[]

/**

* Accepts a path array and converts to a normalized path string.

* The string will be in a form like:

* `$['aProperty']['anotherProperty][0]`.

* The JSONPath terminal constructions `~` and `^` and type operators

* like `@string()` are silently stripped.

static toPathString(path: string[]): string

/**

* Accepts a path array and converts to a JSON Pointer.

* The string will be in a form like: `/aProperty/anotherProperty/0`

* (with any `~` and `/` internal characters escaped as per the JSON

* Pointer spec).

* The JSONPath terminal constructions `~` and `^` and type operators

* like `@string()` are silently stripped.

static toPointer(path: string[]): any

evaluate(

path: JSONPathOptions['path'],

json: JSONPathOptions['json'],

callback: JSONPathOptions['callback'],

otherTypeCallback: JSONPathOptions['otherTypeCallback']

): any

evaluate(options: {

path: JSONPathOptions['path'],

json: JSONPathOptions['json'],

callback: JSONPathOptions['callback'],

otherTypeCallback: JSONPathOptions['otherTypeCallback']

}): any

}

type JSONPathType = JSONPathCallable & JSONPathClass

export const JSONPath: JSONPathType

}

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

jsonpath.d.ts

Latest commit

History

jsonpath.d.ts

File metadata and controls