Installation

npm install --save @types/body-parser-xml

Summary

This package contains type definitions for body-parser-xml (https://github.com/fiznool/body-parser-xml).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/body-parser-xml.

index.d.ts

1/// <reference types="node" />
2
3// import bodyParser = require('body-parser');
4import { BodyParser } from "body-parser";
5import { NextHandleFunction } from "connect";
6import { Request, Response } from "express-serve-static-core";
7import { ParserOptions } from "xml2js";
8
9/**
10 * This library adds an xml method to the body-parser object.
11 */
12declare function bodyParserXml(bodyParser: BodyParser): void;
13
14declare namespace bodyParserXml {
15    interface Options {
16        /**
17         * Specify the default character set for the text content if the charset is not specified in the Content-Type header of the request.
18         * @default 'utf-8'
19         */
20        defaultCharset?: BufferEncoding | undefined;
21        /**
22         * When set to true, then deflated (compressed) bodies will be inflated; when false, deflated bodies are rejected.
23         * @default true
24         */
25        inflate?: boolean | undefined;
26        /**
27         * Controls the maximum request body size. If this is a number, then the value specifies the number of bytes; if it is a string, the value is passed to the bytes library for parsing.
28         * @default '100kb'
29         */
30        limit?: string | number | undefined;
31        /**
32         * The type option is used to determine what media type the middleware will parse.
33         * @default ['_/xml', '+xml']
34         */
35        type?: string | string[] | ((req: Request) => boolean) | undefined;
36        /**
37         * The verify option, if supplied, is called as verify(req, res, buf, encoding),
38         * where buf is a Buffer of the raw request body and encoding is the encoding of the request.
39         * The parsing can be aborted by throwing an error.
40         */
41        verify?: ((req: Request, res: Response, buf: Buffer, encoding: BufferEncoding) => void) | undefined;
42        /**
43         * This option controls the behaviour of the XML parser
44         */
45        xmlParseOptions?: ParserOptions | undefined;
46    }
47}
48
49export = bodyParserXml;
50
51declare module "body-parser" {
52    interface BodyParser {
53        xml(options?: bodyParserXml.Options): NextHandleFunction;
54    }
55}
56

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/body-parser, @types/connect, @types/express-serve-static-core, @types/node, @types/xml2js

Credits

These definitions were written by tbounsiar, and Piotr Błażejewicz.