@nhtio/lucid-resourceful/encoding
Portable cross-environment encoding and decoding of structured data.
Classes
| Class | Description |
|---|---|
| E_CIRCULAR_REFERENCE | Exception thrown when a circular reference is detected during encoding. Circular references cannot be encoded and must be avoided. |
| E_INCOMPATIBLE_VERSION | Exception thrown when attempting to decode data encoded with an incompatible version. This typically occurs when the encoded data is from a newer version than the decoder supports. |
| E_INVALID_VERSION | Exception thrown when an invalid version string is encountered. |
| E_NOT_AN_ENCODED_VALUE | Exception thrown when attempting to decode a value that is not a valid encoded value. This indicates the input string is not in the expected encoded format. |
| E_UNDECODABLE_VALUE | Exception thrown when a value with an unknown or unsupported type cannot be decoded. |
| E_UNENCODABLE_VALUE | Exception thrown when a value cannot be encoded. This indicates that the value type is not supported by the encoder. |
| FunctionSerializer | A portable function serializer that can dehydrate and rehydrate functions from strings, with support for named bindings and various function types. |
Interfaces
| Interface | Description |
|---|---|
| BaseException | Base exception class that extends the native Error class. Provides a foundation for all custom exceptions with additional metadata like error codes, status codes, and help descriptions. |
Type Aliases
| Type Alias | Description |
|---|---|
| DehydratedFunctionValue | Type definition for a dehydrated function value |
| Encodable | Defines all the types which can be be encoded |
Variables
| Variable | Description |
|---|---|
| decode | Decodes a compressed base64 string back into a value |
| encode | Encodes a value into a compressed base64 string |
| version | The current version of the package. |