From 3535498bb0d6e81e875f017ba520f3f9ad8918c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Blanchon?= Date: Sat, 14 Nov 2015 22:12:22 +0100 Subject: [PATCH] Updated API Reference (markdown) --- API-Reference.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/API-Reference.md b/API-Reference.md index 8b00872..e42e328 100644 --- a/API-Reference.md +++ b/API-Reference.md @@ -138,6 +138,53 @@ const char* value2 = array.get(2); // returns NULL ##### Example ```c++ ``` + +## JsonArray::printTo() + +### Description + +Serialize the array to a JSON string. + +This will create a compact JSON, if you want a pretty JSON with spaces and line breaks, use `JsonArray::prettyPrint()` + +### Signatures + +```c++ +size_t printTo(char* buffer, size_t size) const; +size_t printTo(Print &) const; +size_t printTo(String &) const; +``` + +### Arguments + +The destination of the JSON string. + +Can be either: + +* a `buffer` with specified `size` +* an implementation of `Print` (like `Serial`, `EthernetClient`...) +* a `String` + +### Return value + +The number of bytes written + +### Example + +```c++ +StaticJsonBuffer<200> jsonBuffer; +JsonArray& array = jsonBuffer.createArray(); +array.add("hello"); +array.add("world"); +array.printTo(Serial); +``` + +will write the following string to the serial output: + +```json +["hello","world"] +``` + #### JsonArray::removeAt() ##### Description Removes element at specified index.