Description

JsonObject::remove() removes a key-value pair from the object pointed by the JsonObject.

If the JsonObject is null, this function does nothing.

Signatures

void remove(const char* key) const;
void remove(const __FlashStringHelper* key) const;

void remove(const String& key) const;
void remove(const std::string& key) const;

Arguments

key: the key to remove from the object.

Example

JsonObject object = doc.to<JsonObject>();
object["A"] = 1;
object["B"] = 2;
object["C"] = 3;
object.remove("B");
serializeJson(object, Serial);

will print the following string to the serial output:

{"A":1,"C":3}

See also

Causes memory leaks ⚠️

Because JsonDocument contains a monotonic allocator, this function cannot release the memory associated with the removed key-value pair.

As a consequence, you cannot remove and add elements in a loop; otherwise the JsonDocument will overflow.