[#nlohmann-basic_json-0c-to_bjdata-07]
= xref:nlohmann.adoc[nlohmann]::xref:nlohmann/basic_json-0c.adoc[basic_json]::to_bjdata
:relfileprefix: ../../
:mrdocs:

create a BJData serialization of a given JSON value

== Synopsis

Declared in `<nlohmann/json.hpp>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
std::vector<uint8_t>
to_bjdata(
    xref:nlohmann/basic_json-0c.adoc[basic_json] const& j,
    bool const use_size = false,
    bool const use_type = false,
    xref:nlohmann/basic_json-0c/bjdata_version_t.adoc[bjdata_version_t] const version = bjdata_version_t::draft2);
----

== Return Value

a BJData serialization of _j_ as a byte vector

== Parameters

[cols="1,4"]
|===
| Name| Description
| *j*
| JSON value to serialize
| *use_size*
| whether to add size annotations to container types
| *use_type*
| whether to add type annotations to container types (must be combined with _use_size_ = true)
| *version*
| the BJData version to use for the serialization
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#