> For the complete documentation index, see [llms.txt](https://senselab.gitbook.io/senselab-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://senselab.gitbook.io/senselab-docs/vendor/colinodell/json5/changelog.md).

# Changelog

All notable changes to `colinodell/json5` will be documented in this file.

Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.

## [Unreleased](https://github.com/colinodell/json5/compare/v3.0.0...HEAD)

## [3.0.0](https://github.com/colinodell/json5/compare/v2.3.0...v3.0.0) - 2024-02-09

You should not notice any breaking changes in this release unless you were using named parameters, or ignoring argument types defined in docblocks.

### Changed

* Renamed function parameters to match `json_decode()`'s signature
  * `$source` is now `$json`
  * `$options` is now `$flags`
* Added explicit `mixed` return type to match `json_decode()`
* Added proper types to all parameters and return values of `SyntaxError`
* Renamed two arguments in the `SyntaxError`'s constructor:
  * `$linenumber` is now `$lineNumber`
  * `$columnNumber` is now `$column`

### Removed

* Removed support for PHP 7.x (8.0+ is now required)

## [2.3.0](https://github.com/colinodell/json5/compare/v2.2.2...v2.3.0) - 2022-12-27

### Added

* Added parameter and return types matching the existing docblocks

### Fixed

* Fixed missing `@throws` docblocks needed for PhpStorm to recognize exceptions (#21)

## [2.2.2](https://github.com/colinodell/json5/compare/v2.2.1...v2.2.2) - 2022-02-21

### Fixed

* Fixed "small" integers always being cast to strings when `JSON_BIGINT_AS_STRING` is set (#17)
* Fixed exceptions not being thrown when invalid UTF-16 escape sequences are encountered in strings

## [2.2.1](https://github.com/colinodell/json5/compare/v2.2.0...v2.2.1) - 2021-11-06

### Fixed

* Fixed exceptions always being thrown on PHP 7.3+ when parsing valid JSON5 with `JSON_THROW_ON_ERROR` explicitly set to true (#15)

## [2.2.0](https://github.com/colinodell/json5/compare/v2.1.0...v2.2.0) - 2020-11-29

### Added

* Added support for PHP 8.0

### Removed

* Removed support for PHP 5.6 and 7.0

## [2.1.0](https://github.com/colinodell/json5/compare/v2.0.0...v2.1.0) - 2019-03-28

### Added

* Added `.phpstorm.meta.php` for better code completion
* Added several tiny micro-optimizations

### Removed

* Removed support for PHP 5.4 and 5.5

## [2.0.0](https://github.com/colinodell/json5/compare/v1.0.5...v2.0.0) - 2018-09-20

### Added

* Added a polyfill for class `\JsonException` (added in PHP 7.3)
* Added a polyfill for constant `JSON_THROW_ON_ERROR`

### Changed

* The `SyntaxError` class now extends from `\JsonException`

## [1.0.5](https://github.com/colinodell/json5/compare/v1.0.4...v1.0.5) - 2018-09-20

### Fixed

* Fixed exceptions not being thrown for incomplete objects/arrays

## [1.0.4](https://github.com/colinodell/json5/compare/v1.0.3...v1.0.4) - 2018-01-14

### Changed

* Modified the internal pointer and string manipulations to use bytes instead of characters for better performance (#4)

## [1.0.3](https://github.com/colinodell/json5/compare/v1.0.2...v1.0.3) - 2018-01-14

### Fixed

* Fixed check for PHP 7+

## [1.0.2](https://github.com/colinodell/json5/compare/v1.0.1...v1.0.2) - 2018-01-14

This release contains massive performance improvements of 98% or more, especially for larger JSON inputs!

### Added

* On PHP 7.x: parser will try using `json_decode()` first in case normal JSON is given, since this function is much faster (#1)

### Fixed

* Fixed multiple performance issues (#1)
* Fixed bug where `JSON_OBJECT_AS_ARRAY` was improperly taking priority over `assoc` in some cases

## [1.0.1](https://github.com/colinodell/json5/compare/v1.0.0...v1.0.1) - 2017-11-11

### Removed

* Removed accidentally-public constant

## 1.0.0 - 2017-11-11

### Added

* Initial commit


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://senselab.gitbook.io/senselab-docs/vendor/colinodell/json5/changelog.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.