# @types/jsonpath-plus

> TypeScript definitions for jsonpath-plus

Latest version **5.0.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/jsonpath-plus
pnpm add @types/jsonpath-plus
yarn add @types/jsonpath-plus
bun add @types/jsonpath-plus
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.0.5 |
| Published | 2023-11-07 |
| First published | 2021-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51436 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/jsonpath-plus
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsonpath-plus
- npm.io page: https://npm.io/package/@types/jsonpath-plus

## Recent versions

- 5.0.5 (latest) — 2023-11-07
- 5.0.2 (ts3.6) — 2021-07-08
- 5.0.1 (ts3.4) — 2021-02-17
- 5.0.4 — 2023-10-18
- 5.0.3 — 2023-09-15
- 5.0.0 — 2021-01-27

## README

# Installation
> `npm install --save @types/jsonpath-plus`

# Summary
This package contains type definitions for jsonpath-plus (https://github.com/s3u/JSONPath).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsonpath-plus.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsonpath-plus/index.d.ts)
````ts
export as namespace JSONPath;

export type pathType = string | string[];
export type jsonType = null | boolean | number | string | object | [];
export type resultType =
    | "VALUE"
    | "Value"
    | "value"
    | "PATH"
    | "Path"
    | "path"
    | "POINTER"
    | "Pointer"
    | "pointer"
    | "PARENT"
    | "Parent"
    | "parent"
    | "PARENTPROPERTY"
    | "ParentProperty"
    | "parentProperty"
    | "parentproperty";
export type sandboxType = {
    [key in string]: string;
};
export type callback = (payloadValue: any, type: "value" | "property", fullPayload: any) => void;
export type otherCallback = (value: any, path: string, parent: object, parentPropertyName: any) => boolean;

export interface options {
    path?: pathType | undefined;
    json?: jsonType | undefined;
    autostart?: boolean | undefined;
    flatten?: boolean | undefined;
    resultType?: resultType | undefined;
    sandbox?: sandboxType | undefined;
    wrap?: boolean | undefined;
    preventEval?: boolean | undefined;
    parent?: object | undefined;
    parentProperty?: object | undefined;
    callback?: callback | undefined;
    otherTypeCallback?: otherCallback | undefined;
}

export function JSONPath(
    options?: options,
    path?: pathType,
    json?: jsonType,
    callback?: callback,
    otherTypeCallback?: otherCallback,
): object | object[];
export function JSONPath(
    path?: pathType,
    json?: jsonType,
    callback?: callback,
    otherTypeCallback?: otherCallback,
): object | object[];

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by [Chris Barth](https://github.com/cjbarth).

---
_Source: https://npm.io/package/@types/jsonpath-plus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._