Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

JSON.stringify: wartość JavaScript na tekst JSON

JSON.stringify serializuje wartość JavaScript do tekstu JSON, z opcjonalnym replacerem do wyboru lub zmiany danych i parametrem space do wcięć.

Wersja: ECMAScript 5 onward; well-formed lone-surrogate escaping from ECMAScript 2019; example target: Node.js 24.22.2

Składnia

JSON.stringify(value[, replacer[, space]])

JSON.stringify(value, replacer?, space?) zwraca łańcuch JSON albo undefined, gdy wartością najwyższego poziomu jest undefined, funkcja lub Symbol. W obiekcie takie wartości są pomijane, a w tablicy stają się null; NaN i nieskończoności również stają się null, a -0 zapisuje się jako 0. Serializowane są własne wyliczalne właściwości o kluczach łańcuchowych w określonej kolejności jak w Object.keys; klucze Symbol są ignorowane. Opis własnych wyliczalnych właściwości dotyczy listy domyślnej; tablica replacera odczytuje nazwane właściwości przez Get, więc może objąć odziedziczoną albo niewyliczalną.

Funkcja toJSON, jeżeli istnieje, działa przed replacer. Replacer-funkcja otrzymuje (key, value), z this ustawionym na obiekt zawierający właściwość, i może ją zastąpić lub pominąć przez zwrócenie undefined; wywołanie dla korzenia używa klucza "". Tablica replacera tworzy listę dopuszczonych kluczy właściwości obiektów. Liczbowe space jest ograniczane do 10 spacji, a łańcuchowe do pierwszych 10 znaków. Dla łańcuchowego space „10 znaków” oznacza dokładnie pierwsze 10 jednostek kodowych UTF-16.

Cykliczne odwołanie powoduje TypeError. BigInt również powoduje TypeError, chyba że zwykły odczyt właściwości znajdzie wywoływalne toJSON; metoda może pochodzić z prototypu. Wyjątki z gettera, toJSON lub replacera są przekazywane dalej. Stabilna kolejność nie oznacza kanonicznego JSON dla podpisów kryptograficznych. Metoda jest standardowa od ECMAScript 5; od ECMAScript 2019 samotne jednostki zastępcze Unicode są zapisywane jako sekwencje \ud800–\udfff, dzięki czemu wynik jest poprawnym Unicode.

Przykłady

const value = {
  name: "Ada",
  missing: undefined,
  numbers: [1, NaN, Infinity, undefined],
  nested: { keep: true, secret: "hidden" },
};
console.log(JSON.stringify(value, (key, current) =>
  key === "secret" ? undefined : current,
));
console.log(JSON.stringify(undefined) === undefined);

try {
  JSON.stringify(1n);
} catch (error) {
  console.log(error instanceof TypeError);
}

const cycle = {};
cycle.self = cycle;
try {
  JSON.stringify(cycle);
} catch (error) {
  console.log(error instanceof TypeError);
}

Wynik

{"name":"Ada","numbers":[1,null,null,null],"nested":{"keep":true}}
true
true
true

Źródła