npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

xml-serializer-ts

v1.0.2

Published

Decorators for xml serialization

Downloads

80

Readme

Build Status

Dependencies status

xml-decorators

Decorators for xml serialization. Uses js2xmlparser under the hood.

Usage of decorators

import {XMLElement, XMLAttribute, XMLChild, xml} from 'xml-decorators';

const HOBBY_NS = 'h';

class Hobby {

  @XMLAttribute({namespace: HOBBY_NS})
  private name: string;

  @XMLAttribute({namespace: HOBBY_NS})
  private description: string;
}

const PERSON_ROOT = 'person';
const PERSON_NS = 'ps';

@XMLElement({root: PERSON_ROOT}) // optional
class Person {

  @XMLAttribute({namespace: PERSON_NS})
  private firstname: string;

  private lastname: string;

  @XMLAttribute({namespace: PERSON_NS})
  get fullname(): string {

    return this.firstname + ' ' + this.lastname;
  }

  @XMLAttribute({namespace: PERSON_NS})
  private age: number;

  @XMLChild({
    namespace: PERSON_NS,
    name: 'hobby'
  })
  private hobbies: Hobby[];

  @XMLChild({
    namespace: PERSON_NS,
    stripPluralS: true
  })
  private friends: Person[];

  @XMLChild({
    name: 'pet',
    implicitStructure: 'pets.$'
  })
  private pets: string[];
  
 }

Serialization

const hobbies = [
  new Hobby('reading', 'loves to read books, magazines and web articles'),
  new Hobby('listening to Music', 'loves to listen to rock music'),
  new Hobby('travelling', 'loves to travel around the world'),
];
const pets = ['dog', 'cat'];
const bob = new Person('Bob', 'Mad', 29, hobbies, pets);

const bobXml = xml.serialize(bob);

Or if you want to override the root tag name or did not used the @XMLElement annotation.

const bob2Xml = xml.serialize('great-person', bob);

Result

<?xml version='1.0'?>
<great-person ps:firstname='Bob' ps:fullname='Bob Mad' ps:age='29'>
    <ps:hobby h:name='reading' h:description='loves to read books, magazines and web articles'/>
    <ps:hobby h:name='listening to Music' h:description='loves to listen to rock music'/>
    <ps:hobby h:name='travelling' h:description='loves to travel around the world'/>
    <pets>
        <pet>dog</pet>
        <pet>cat</pet>
    </pets>
</great-person>

Async

xml
  .serializeAsync(bob)
  .then(bobXml => console.log(bobXml))
  ;

Schema

If you want to retrieve the "js2xmlparser" schema instead:

xml.getSchema(bob);
xml.getSchemaAsync(bob).then(/* */);