XML to TypeScript

Generate TypeScript types from XML automatically.

Local Your input is processed locally in your browser. Found a problem? Report an issue

What XML to TypeScript does

XML to TypeScript turns a sample XML document into TypeScript code: one interface per object, with a type for every field inferred from the value in the sample.

XML to TypeScript examples

The built-in sample

Input

<users><user id="1"><name>Ada</name></user><user id="2"><name>Lin</name></user></users>

Output

export interface Root {
  _id: string;
  name: string;
}

This is the input that the Load sample button fills in.

Attributes, repeated elements and empty elements

Input

<order id="7" paid="false"><total>19.5</total><item sku="A1"><qty>2</qty></item><item sku="B2"><qty>1</qty><gift/></item><note/></order>

Output

export interface Item {
  _sku: string;
  qty: string;
  gift: string;
}

export interface Root {
  _id: string;
  _paid: string;
  total: string;
  item: Item[];
  note: string;
}

In the sample, id, paid and sku are attributes, item repeats, and gift and note are empty elements. Every value is typed as a string, because XML does not carry types.

Each output was produced by running this tool on the input above it.

How it works

The sample is walked recursively and each value is mapped to a TypeScript type:

Sample valueTypeScript type
Stringstring
Whole numbernumber
Decimal numbernumber
true / falseboolean
null, or an empty array’s itemsany
Array of TT[]
Objecta new named type

XML has no data types, so every leaf value is generated as the TypeScript string type. Attributes become fields too: the @ prefix becomes an underscore (_id). Repeated elements become lists, and the root element itself is always called Root.

Reading XML into the generated types

JavaScript XML parsers that return plain objects mark attribute names with a prefix of their own. Rename the _id style properties to match the prefix of the parser you use.

Details and limits

  • A key that is not a valid identifier is renamed with underscores (order-id becomes order_id), so the interface no longer matches the data. Change the property back to a quoted name, "order-id": number.
  • Whole numbers and decimals are both number.
  • Every property is required. Add ? to the ones that can be absent.
  • A type is named after the key that holds the object: items gives a type called Items, with no attempt to make it singular. The top-level type is always Root.
  • If two different objects sit under the same key name in different places, two types with the same name are generated. Rename one of them.
  • Objects in an array are merged into one type. A field that only some of them have is still generated as a required field.
  • Input that is not valid XML stops the tool, and the status line shows where the problem is. The XML Validator page lists the usual causes.

Questions

Is my data uploaded when I use XML to TypeScript?

No. The tool runs in your browser, so what you paste or open is processed on your own device and is not sent to a server.

What does XML to TypeScript do?

XML to TypeScript turns a sample XML document into TypeScript code: one interface per object, with a type for every field inferred from the value in the sample.

Are there any limits I should know about?

A key that is not a valid identifier is renamed with underscores (order-id becomes order_id), so the interface no longer matches the data. Change the property back to a quoted name, "order-id": number. Whole numbers and decimals are both number.

Is there a size limit?

There is no fixed size limit. Everything happens on your device, so very large inputs depend on its memory and can take longer on a phone than on a computer.

Does it work on phones, and is it free?

Yes. It works in any current browser on Android phones, iPhones, tablets and computers. It is free and needs no account or sign-up.