DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/resx package

2.0.4 • Public • Published

travis npm


The source is available for download from GitHub. Alternatively, you can install using npm:

npm install --save resx

You can then import or require() resx as normal:

import resx from 'resx'
// or
const resx = require('resx')

resx.resx2js(xml, (err, res) => {})

Or you can direclty import or require() its functions:

import resx2js from 'resx/resx2js'
// or
const resx2js = require('resx/cjs/resx2js')


const xml = `<?xml version="1.0" encoding="utf-8"?>
    Microsoft ResX Schema

    Version 2.0

    The primary goals of this format is to allow a simple XML format
    that is mostly human readable. The generation and parsing of the
    various data types are done through the TypeConverter classes
    associated with the data types.


    ... headers & schema ...
    <resheader name="resmimetype">text/microsoft-resx</resheader>
    <resheader name="version">2.0</resheader>
    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
    <data name="Bitmap1" mimetype="application/">
        <value>[base64 mime encoded serialized .NET Framework object]</value>
    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/">
        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
        <comment>This is a comment</comment>

    There are any number of "resheader" rows that contain simple
    name/value pairs.

    Each data row contains a name, and value. The row also contains a
    type or mimetype. Type corresponds to a .NET class that support
    text/value conversion through the TypeConverter architecture.
    Classes that don't support this are serialized and stored with the
    mimetype set.

    The mimetype is used for serialized objects, and tells the
    ResXResourceReader how to depersist the object. This is currently not
    extensible. For a given mimetype the value must be set accordingly:

    Note - application/ is the format
    that the ResXResourceWriter will generate, however the reader can
    read any of the formats listed below.

    mimetype: application/
    value   : The object must be serialized with
            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
            : and then encoded with base64 encoding.

    mimetype: application/
    value   : The object must be serialized with
            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
            : and then encoded with base64 encoding.

    mimetype: application/
    value   : The object must be serialized into a byte array
            : using a System.ComponentModel.TypeConverter
            : and then encoded with base64 encoding.
  <xsd:schema id="root" xmlns="" xmlns:xsd="" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xsd:import namespace=""/>
    <xsd:element name="root" msdata:IsDataSet="true">
        <xsd:choice maxOccurs="unbounded">
          <xsd:element name="metadata">
                <xsd:element name="value" type="xsd:string" minOccurs="0"/>
              <xsd:attribute name="name" use="required" type="xsd:string"/>
              <xsd:attribute name="type" type="xsd:string"/>
              <xsd:attribute name="mimetype" type="xsd:string"/>
              <xsd:attribute ref="xml:space"/>
          <xsd:element name="assembly">
              <xsd:attribute name="alias" type="xsd:string"/>
              <xsd:attribute name="name" type="xsd:string"/>
          <xsd:element name="data">
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2"/>
              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1"/>
              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3"/>
              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4"/>
              <xsd:attribute ref="xml:space"/>
          <xsd:element name="resheader">
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
              <xsd:attribute name="name" type="xsd:string" use="required"/>
  <resheader name="resmimetype">
  <resheader name="version">
  <resheader name="reader">
    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  <resheader name="writer">
    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  <data name="key1" xml:space="preserve">
  <data name="key2" xml:space="preserve">
    <value>An application to manipulate and process resx documents</value>
  <data name="key.nested" xml:space="preserve">
    <value>resx Data Manager</value>

const js = {
  "key1": "Hello",
  "key2": "An application to manipulate and process resx documents",
  "key.nested": "resx Data Manager"

import resx2js from 'resx/resx2js'
resx2js(xml, (err, res) => {
  // res is like js

import js2resx from 'resx/js2resx'
js2resx(js, (err, res) => {
  // res is like xml

Omitting the callback returns a promise

const resJs = await resx2js(xml)
const resXml = await js2resx(js)
// or
resx2js(xml).then((res) => {})
js2resx(js).then((res) => {})

Package Sidebar


npm i resx


Weekly Downloads






Unpacked Size

636 kB

Total Files


Last publish


  • adrai
  • jamuhl