@cqrs-ddd/safe-stringify
Δύο serializers JSON με αντίθετους στόχους, και helpers τμημάτων κλειδιών για τη δημιουργία κλειδιών ταυτότητας. Χωρίς runtime εξαρτήσεις και χωρίς framework.
Strict: stableStringify, toStrictJsonValue |
Safe: safeStringify, safeSanitize, redactValue |
|
|---|---|---|
| Χρήση | Ταυτότητα: cache keys, αποτυπώματα idempotency, αποθηκευμένα snapshots | Εμφάνιση: logs, καταγραφές audit και dead-letter payloads |
| Έξοδος | Ντετερμινιστικό JSON, ταξινομημένα κλειδιά σε κάθε επίπεδο, σταθερό μεταξύ εκδόσεων | Αναγνώσιμο JSON κατά σειρά εισαγωγής. Η μορφή μπορεί να εξελιχθεί |
| Μη υποστηριζόμενη είσοδος | Ρίχνει TypeError |
Δεν ρίχνει ποτέ σφάλμα |
| Μυστικά (Secrets) | Δεν αποκρύπτει ποτέ (ένα κλειδί δεν επιτρέπεται να αλλάξει) | Εξαιρεί και αποκρύπτει κατόπιν αιτήματος |
Χρησιμοποιήστε τον strict serializer για οτιδήποτε ταυτοποιεί δεδομένα. Μην χρησιμοποιείτε ποτέ το safeStringify για κλειδί ή αποτύπωμα: η έξοδός του δεν είναι ταξινομημένη, αντικαθιστά τιμές που δεν μπορεί να αναπαραστήσει, και η μορφή του μπορεί να αλλάξει.
Εγκατάσταση
Ενότητα με τίτλο «Εγκατάσταση»Απαιτεί Node.js 22.12 ή νεότερο.
Strict Serializer
Ενότητα με τίτλο «Strict Serializer»- Strings, booleans,
nullκαι πεπερασμένοι αριθμοί διατηρούνται. Ημερομηνίες γίνονται ISO-8601 strings. Αντικείμενα μεtoJSON()αντικαθίστανται από την επιστρεφόμενη τιμή. - Οτιδήποτε άλλο ρίχνει
TypeError:undefined, συναρτήσεις,bigint, symbols, μη πεπερασμένοι αριθμοί, κυκλικές αναφορές, sparse arrays,Map,Set,Error,RegExp, boxed primitives όπωςnew Number(1), iterable αντικείμενα χωρίςtoJSON()όπωςURLSearchParamsήHeaders, κ.ά. - Δομικά ισοδύναμες τιμές παράγουν πανομοιότυπα strings, ανεξαρτήτως της σειράς εισαγωγής των ιδιοτήτων. Τα κλειδιά ταξινομούνται κατά UTF-16 code unit.
Safe Serializer
Ενότητα με τίτλο «Safe Serializer»- Τα
safeStringify(value, options?, indent?)καιsafeSanitize(value, options?)δεν ρίχνουν ποτέ σφάλμα. Κύκλοι γίνονται"[Circular]", σφάλματα επεκτείνονται σεname,message,stack, και μη υποστηριζόμενες τιμές αντικαθίστανται από αναγνώσιμους δείκτες ("[bigint]","[Function]"). - Δεν αποκρύπτουν τίποτα εκτός αν περάσετε
redactKeys. ΤοredactValue(value, keys?)εφαρμόζειDEFAULT_REDACT_KEYSεξ ορισμού.
Τμήματα κλειδιών (Key segments)
Ενότητα με τίτλο «Τμήματα κλειδιών (Key segments)»- Το
joinKeySegments(segments)κάνει escape κάθε τμήμα και τα ενώνει με:. ΤαundefinedκαιnullγίνονταιABSENT_SEGMENT(\-). - Το
escapeKeySegment(value)κάνει escape πρώτα το\και μετά το:.
Κατασκευή cache key:
Άδεια χρήσης
Ενότητα με τίτλο «Άδεια χρήσης»Διπλή άδεια υπό AGPLv3 και Commercial License. Δείτε τα αρχεία LICENSE και COMMERCIAL_LICENSE.txt στη ρίζα του repository.