npmpackage.info

Gathering detailed insights and metrics for saxes-stream

Other packages similar to saxes-stream

xml-stream-saxes

0.4.9

XML stream to JavaScript object converter based on Saxes.

saxes-stream

NodeJS Streams wrapper around SaxesParser (package saxes) with single event stream.

1.1.3

GPL-3.0

TypeScript

680.00 B

1,376 1.7

Installations

npm install saxes-stream

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.16.1

NPM Version

6.14.3 Score

69.8

Supply Chain

99.3

Quality

75.4

Maintenance

100

Vulnerability

80.9

License

Pull Requests

Open

6

Total

12

Closed

0

Merged

6

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 1 Contributors

Languages

TypeScript

JavaScript

TypeScript (94.52%)

JavaScript (5.48%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

SmallhillCZ

Download Statistics

Total Downloads

1,376

Last Day

Last Week

Last Month

Last Year

149

GitHub Statistics

GPL-3.0 License

2 Stars

33 Commits

2 Watchers

7 Branches

1 Contributors

Updated on Jun 01, 2021

Bundle Size

1.41 kB

Minified

680.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.1.3

Package Id

saxes-stream@1.1.3

Unpacked Size

48.54 kB

Size

16.46 kB

File Count

NPM Version

6.14.3

Node Version

12.16.1

Total Downloads

Cumulative downloads

Total Downloads

1,376

Last Day

Compared to previous day

Last Week

Compared to previous week

Last Month

-26.1%

Compared to previous month

Last Year

-30.4%

149

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

saxes

Dev Dependencies

@types/jest @types/node jest saxes ts-jest typescript

SaxesStream

NodeJS Streams wrapper around SaxesParser (npm package saxes)

Single event stream
Pipable to other streams
TypeScript declarations

API

Input

Any string/Buffer Saxes would accept.

Output chunk format:

1import { SaxesTag } from "saxes";
2
3export type SaxesStreamChunk =
4  { event: "opentag", path: string, tag: SaxesTag } |
5  { event: "text", path: string, text: string } |
6  { event: "closetag", path: string, tag: SaxesTag };

Events

Standard NodeJS Streams events.

Example 1 - Get huge online XML of books and stream parse it into CSV

1
2import { SaxesOptions, SaxesStream, SaxesStreamChunk } from "saxes-stream";
3
4import { Transform, TransformOptions, TransformCallback } from "stream";
5import request from "request";
6import fs from "fs";
7import stringify from "csv-stringify";
8
9
10/* Source HTTP XML stream */
11const httpStream = request(url);
12
13
14/* SaxesStream XML parser */
15const const saxesOptions: SaxesOptions = {
16  // ...
17}
18
19const streamOptions: TransformOptions = {
20  // ...
21}
22
23const parser = new SaxesStream(saxesOptions, streamOptions);
24
25
26/* Custom Transform Stream to pick the data from XML */
27class BookTransform extends Transform {
28
29  item: any = {};
30
31  // Stream setting 
32  readableObjectMode = true;
33  writableObjectMode = true;
34
35  _transform(chunk: SaxesStreamChunk, encoding: string, callback: TransformCallback) {
36
37    /* Save parts by matching path */
38    if (chunk.event === "text") {
39      switch (chunk.path) {
40        case ".books.book.title": this.item["title"] = chunk.text; break;
41        case ".books.book.content": this.item["content"] = chunk.text; break;
42      }
43    }
44
45    /* On ending </book> tag emit the completed book object as data (or piped to a next stream) */
46    if (chunk.event === "closetag") {
47      switch (chunk.path) {
48        case ".books.book":
49          this.push(this.item); 
50          this.item = {};
51          break;
52      }
53    }
54
55    callback();
56
57  }
58
59}
60
61const bookTransform = new BookTransform();
62
63
64/* JSON -> CSV Transform Stream */
65const csv = stringify({ delimiter: ',' });
66
67
68/* File Write Stream */
69const file = fs.createWriteStream('./books.csv');
70
71
72/* PIPE ALL THINGS TOGETHER */
73httpStream.pipe(parser).pipe(bookTransform).pipe(csv).pipe(file);
74
75

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More