Except with regards to error details (see below), we will not knowingly introduce a breaking API change without incrementing the major version of the package.
In order to continuously improve the development experience, we may make changes to error messages and error details in any release (even minor and patch releases). As such, you should consider all error messages and error details returned from our API to be informational only and subject to change.
The one exception to this is an error’s name
property. We treat an error
name
as an identifier for the kind of error that occurred, and we consider any
changes to this value to be a breaking change. If your application needs to take
conditional action based on an error, it should only rely upon the value of an
error’s name
.
Aside from name
, all other properties on an error produced by our API
(message
, expected
, etc.) should be considered informational only, subject
to change in any future release, and intended only to help you during
development.