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

@justajwolf/body-parser-xml

v1.0.0

Published

This is nodejs body parser xml middleware.

Downloads

1

Readme

express-body-parser-xml

The pkg is a extension relative to the body-parser library. you can use it to parser xml data and convert into JavaScript Object, mounting on req.body.

The config options is highly opened:

  • you can use your read to extract raw body from request stream if you think the default is not satisfied with your case.
  • you can custom parser xml, just to set the parser into options, passing in middleware.

Installation

$ npm install express-body-parser-xml

Usage

for js

const { XMLParseMiddleware } = require('express-body-parser-xml');
app.use(XMLParseMiddleware());

for ts

import { XMLParseMiddleware } from 'express-body-parser-xml';
app.use(XMLParseMiddleware());

Options

  • types
    • an array of types to match incoming request content-type.
  • limit
    • only parser content-length less than limit body.
  • charset
    • ascii
    • utf8
    • utf-8
    • utf16le
    • ucs2
    • ucs-2
    • base64
    • base64url
    • latin1
    • binary
    • hex
  • parser
    • parser text to js object, the default is xml2js.
  • defaultParserOpts
    • parserOpts for xml2js parser
  • read
    • extract data from request stream.

Default Options

{
  types: ['*/xml', '+xml'],
  limit: '1mb',
  charset: 'utf8',
  parser: defaultParser,
  defaultParserOpts: { async: true, explicitArray: false },
  read: defaultRead,
}

Custom Parser type

type IParser = (xmlRaw: string) => Promise<Record<string, any>>;

Custom Read

It will be considered to be right, when only the readRes.status === 200.

interface IReadRes {
  status: number;
  msg?: string;
  rawBody: string;
}
type IRead = (req: Request, opts: IXmlOptions) => Promise<IReadRes>;

Example

for js

const express = require('express');
const { XMLParseMiddleware } = require('express-body-parser-xml');
const app = express();
app.use(XMLParseMiddleware({ limit: '2mb' }));
app.post('/test', async (req, res) => {
  res.end(JSON.stringify(req.body));
});

for ts

import * as express from 'express';
import { XMLParseMiddleware } from 'express-body-parser-xml';
const app = express();
app.use(
  XMLParseMiddleware({
    types: ['text/xml'],
    limit: '2mb',
  }),
);
app.post('/test', async (req: express.Request, res: express.Response) => {
  res.end(JSON.stringify(req.body));
});

Motivation

The chance to build this pkg is that i failed to find one pkg to use easily that parser xml as middleware, when i develop my wechat account service.

After refer to relevant packages, such as body-parser-xml, body-parser, xml2js, type-is and so on. i write this pkg by ts.

In brief, thanks a lot, owing to the above pkgs, this pkg can born.

License

MIT