https://github.com/croct-tech/json-pointer-js
A RFC 6901 compliant JSON pointer library to handle arbitrary structured data.
https://github.com/croct-tech/json-pointer-js
json json-pointer rfc-6901
Last synced: about 2 months ago
JSON representation
A RFC 6901 compliant JSON pointer library to handle arbitrary structured data.
- Host: GitHub
- URL: https://github.com/croct-tech/json-pointer-js
- Owner: croct-tech
- License: mit
- Created: 2022-03-06T12:30:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T16:57:29.000Z (4 months ago)
- Last Synced: 2025-04-11T20:48:30.818Z (about 2 months ago)
- Topics: json, json-pointer, rfc-6901
- Language: TypeScript
- Homepage:
- Size: 958 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
JSON Pointer
A RFC 6901 compliant JSON pointer library to handle arbitrary structured data.
📦Releases
·
🐞Report Bug
·
✨Request Feature
## Introduction
This library provides a fast, [RFC 6901](https://tools.ietf.org/html/rfc6901) compliant
JSON pointer implementation to manipulate arbitrary JSON values with type-safety.
[Relative JSON pointers](https://datatracker.ietf.org/doc/html/draft-bhutton-relative-json-pointer-00)
are also supported.
These are the main highlight that distinguishes it from similar libraries:
- Fast and lightweight, zero dependencies
- Fully compliant with the specification, including validation, serialization, and deserialization
- Provide methods for reading and writing structures
- Restricts operations such that no array becomes sparse
- Ensures that a valid `JsonStructure` modified by a `JsonPointer` results in a still valid `JsonStructure`
## Installation
We recommend using [NPM](https://www.npmjs.com) to install the package:
```sh
npm install @croct-tech/json-pointer
```
## Contributing
Contributions to the package are always welcome!
- Report any bugs or issues on the [issue tracker](https://github.com/croct-tech/json-pointer-js/issues).
- For major changes, please [open an issue](https://github.com/croct-tech/json-pointer-js/issues) first to discuss what you would like to change.
- Please make sure to update tests as appropriate.
## Testing
Before running the test suites, the development dependencies must be installed:
```sh
npm install
```
Then, to run all tests:
```sh
npm run test
```
Run the following command to check the code against the style guide:
```sh
npm run lint
```
## Building
Before building the project, the dependencies must be installed:
```sh
npm install
```
The following command builds the library:
```
npm run build
```
## License
Copyright © 2015-2021 Croct Limited, All Rights Reserved.
All information contained herein is, and remains the property of Croct Limited. The intellectual, design and technical concepts contained herein are proprietary to Croct Limited s and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Croct Limited.