Class JSONPathClass

constructor

• new JSONPathClass(
      opts: string,
      expr?: any,
      obj?: JSONPathCallback,
      callback?: OtherTypeCallback,
      otherTypeCallback?: undefined,
  ): JSONPathClass | typeof JSONPath

  Parameters

  • opts: string

    JSON path to evaluate

  • Optionalexpr: any

    JSON object to evaluate against

  • Optionalobj: JSONPathCallback

    Passed 3 arguments: 1) desired payload per resultType, 2) "value"|"property", 3) Full returned object with all payloads

  • Optionalcallback: OtherTypeCallback

    If @other() is at the end of one's query, this 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).

  • OptionalotherTypeCallback: undefined

  Returns JSONPathClass | typeof JSONPath

• new JSONPathClass(opts: JSONPathOptions): JSONPathClass

  Parameters

  • opts: JSONPathOptions

    If a string, will be treated as expr

  Returns JSONPathClass

_hasParentSelector

callback

currEval

currOtherTypeCallback

currResultType

currSandbox

eval

flatten

ignoreEvalErrors

json

otherTypeCallback

parent

parentProperty

path

resultType

safeVm

sandbox

vm

wrap

_eval

• _eval(
      code: string,
      _v: unknown,
      _vname: string | number,
      path: ExpressionArray,
      parent: unknown,
      parentPropName: ParentProperty,
  ): unknown

  Parameters

  • code: string
  • _v: unknown
  • _vname: string | number
  • path: ExpressionArray
  • parent: unknown
  • parentPropName: ParentProperty

  Returns unknown

_getPreferredOutput

• _getPreferredOutput(ea: ReturnObject): PreferredOutput

  Parameters

  • ea: ReturnObject

  Returns PreferredOutput

_handleCallback

• _handleCallback(
      fullRetObj: ReturnObject,
      callback: JSONPathCallback | undefined,
      type: "value" | "property",
  ): void

  Parameters

  • fullRetObj: ReturnObject
  • callback: JSONPathCallback | undefined
  • type: "value" | "property"

  Returns void

_slice

• _slice(
      loc: string,
      expr: ExpressionArray,
      val: unknown,
      path: ExpressionArray,
      parent: unknown,
      parentPropName: ParentProperty,
      callback: JSONPathCallback | undefined,
  ): ReturnObject[] | undefined

  Parameters

  • loc: string
  • expr: ExpressionArray
  • val: unknown
  • path: ExpressionArray
  • parent: unknown
  • parentPropName: ParentProperty
  • callback: JSONPathCallback | undefined

  Returns ReturnObject[] | undefined

_trace

• _trace(
      expr: ExpressionArray,
      val: unknown,
      path: ExpressionArray,
      parent: unknown,
      parentPropName: ParentProperty,
      callback: JSONPathCallback | undefined,
      hasArrExpr: boolean | undefined,
      literalPriority?: boolean,
  ): ReturnObject | ReturnObject[]

  Parameters

  • expr: ExpressionArray
  • val: unknown
  • path: ExpressionArray
  • parent: unknown
  • parentPropName: ParentProperty
  • callback: JSONPathCallback | undefined
  • hasArrExpr: boolean | undefined
  • OptionalliteralPriority: boolean

  Returns ReturnObject | ReturnObject[]

_walk

• _walk(val: unknown, f: (prop: string | number) => void): void

  Parameters

  • val: unknown
  • f: (prop: string | number) => void

  Returns void

evaluate

• evaluate(expr?: JSONPathOptions): unknown

  Parameters

  • Optionalexpr: JSONPathOptions

  Returns unknown

• evaluate(
      expr?: PathType,
      json?: any,
      callback?: JSONPathCallback | null,
      otherTypeCallback?: OtherTypeCallback,
  ): unknown

  Parameters

  • Optionalexpr: PathType
  • Optionaljson: any
  • Optionalcallback: JSONPathCallback | null
  • OptionalotherTypeCallback: OtherTypeCallback

  Returns unknown