Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: serializer utilities PTL-1699 #2011

Merged
merged 5 commits into from
Dec 3, 2024

Conversation

Gareth-Spencer-Genesis
Copy link
Contributor

ATTENTION! NEW DOCS STRUCTURE
FOR THE NEXT THREE WEEKS, ONLY BRANCH FROM new-docs-structure
OTHERWISE, WAIT UNTIL THE NEW STRUCTURE HAS BEEN RELEASED


Thank you for contributing to the documentation.

Do the changes you have made apply to both Current and Previous versions?
Yes

Have you done a trial build to check all new or changed links?
No

Is there anything else you would like us to know?
Yes

This week's exciting advice from the style guide

  • Write your headings in sentence case:

    • A good example
      This is a correct heading.
    • A Bad Example
      This is not a correct heading.

Copy link
Collaborator

@mahamzafar990 mahamzafar990 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. Just update the code example as mentioned in comment

- **`customNumberParser` Function:** Enhances the parsing of numeric values, supporting safe integers, floating-point numbers, and BigInt values.
- **`JSONSerializer` Interface:** Defines methods for serializing objects to JSON strings and deserializing JSON strings to JavaScript objects, with support for HTTP response objects and message event data.
- **`DefaultJSONSerializer` Class:** Implements the `JSONSerializer` interface, providing default serialization and deserialization behaviors that can be customized via the `JSONSerializerConfig`.
- **`JSONReplacer` and `JSONReviver` Functions:** Facilitate custom serialization and deserialization processes, allowing for the handling of special types, such as dates and NaN values, and the exclusion of properties with specific key prefixes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we get an example of tis this please?

Copy link
Contributor

@matteematt matteematt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed on slack and we're both a bit confused about the features of the JSON serializer. Getting this merged for now and then Gareth will carry on looking into it after

@Gareth-Spencer-Genesis Gareth-Spencer-Genesis merged commit 93c44b4 into new-doc-structure Dec 3, 2024
@Gareth-Spencer-Genesis Gareth-Spencer-Genesis deleted the PTL-1699 branch December 3, 2024 11:17
@Gareth-Spencer-Genesis Gareth-Spencer-Genesis restored the PTL-1699 branch December 3, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants