How to use XML to Flow
- Paste a representative XML sample, ideally one with all the optional fields filled in.
- Set the name of the root type, and decide whether you want helper code as well or types only.
- Copy the generated Flow code into your project.
About XML to Flow
Writing model classes by hand for a big XML payload is dull, and it is where typos creep in. Paste a sample here and the generator works out the structure: which fields exist, which are objects, which are arrays and what type each value has. The output is Flow type aliases for objects and arrays.
XML is first converted to JSON the same way as in our XML to JSON tool: attributes get an @_ prefix and text content next to attributes is called #text. The Flow types are generated from that result. The output starts with the @flow comment so that the checker picks it up.
Using the generated code
Import the types in a file with the @flow pragma, for example const data: Root = JSON.parse(text).
Optional values use the maybe type, ?string, which allows null and undefined.