deploy: 4155e2938f

api/json_document/index.md

@@ -0,0 +1,50 @@
+# nlohmann::json_document
+
+Defined in header `<nlohmann/json_view.hpp>`
+
+```
+using json_document = basic_json_document<json>;
+```
+
+This type is a [`basic_json_document`](https://json.nlohmann.me/api/basic_json_document/index.md) of the default [`json`](https://json.nlohmann.me/api/json/index.md) specialization.
+
+## Examples
+
+Example
+
+The example below demonstrates how to use the type `nlohmann::json_document`.
+
+```
+#include <iostream>
+#include <nlohmann/json_view.hpp>
+
+using json_document = nlohmann::json_document;
+
+int main()
+{
+    std::cout << std::boolalpha;
+
+    // json_document is basic_json_document<nlohmann::json>: same value types
+    // and containers as the ordinary json specialization
+    json_document doc = json_document::parse(R"({"pi": 3.14, "numbers": [1, 2, 3]})");
+
+    std::cout << doc.root().is_object() << '\n';
+    std::cout << doc.root().materialize().dump() << '\n';
+}
+```
+
+Output:
+
+```
+true
+{"numbers":[1,2,3],"pi":3.14}
+```
+
+## See also
+
+- [json_view](https://json.nlohmann.me/api/json_view/index.md) - a view of a value of a `json_document`
+- [ordered_json_document](https://json.nlohmann.me/api/ordered_json_document/index.md) - the corresponding document for `ordered_json`
+
+## Version history
+
+Since version 3.13.0 unreleased.