Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carloseduardodb/pegasus-report-stream
A client-side high-performance report generator that utilizes data streaming
https://github.com/carloseduardodb/pegasus-report-stream
chunked-http frontend javscript report stream typescript websocket
Last synced: about 1 month ago
JSON representation
A client-side high-performance report generator that utilizes data streaming
- Host: GitHub
- URL: https://github.com/carloseduardodb/pegasus-report-stream
- Owner: carloseduardodb
- License: other
- Created: 2023-04-23T00:05:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-25T00:47:55.000Z (over 1 year ago)
- Last Synced: 2024-10-29T12:05:40.155Z (2 months ago)
- Topics: chunked-http, frontend, javscript, report, stream, typescript, websocket
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@carloseduardobatista/pegasus-report-stream
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pegasus Report Stream
Pegasus Report Stream is an application that generates reports based on data obtained via stream using the Fetch API with Transfer-Encoding chunked. The application utilizes the FileSystemFileHandle
feature to save the generated files in CSV format, offering more flexibility in writing the data. However, it's important to note that the use of this feature may be subject to browser compatibility,
as not all browsers support FileSystemFileHandle.
## Installation
To install the Pegasus Report Stream library, simply run the following command:
### NPM
```bash
npm install @carloseduardobatista/pegasus-report-stream
```
### Yarn
```bash
yarn add @carloseduardobatista/pegasus-report-stream
```
## Import the Library
To import the Pegasus Report Stream library, simply run the following command:
```javascript
import { Pegasus } from '@carloseduardobatista/pegasus-report-stream';
```
## Implementation Example
Here's an example of how to use the `getReport()` function to generate a report:
```javascript
async function getReport() {
const data = [
{ id: 5, name: 'João', is_credit: true },
{ id: 6, name: 'Maria', is_credit: false },
{ id: 7, name: 'José', is_credit: true },
{ id: 8, name: 'Mariana', is_credit: false },
{ id: 9, name: 'Moacir', is_credit: true }
];
const jsonData = data.map((obj) => JSON.stringify(obj)).join('\n');
const encoder = new TextEncoder();
const uint8Array = encoder.encode(jsonData);
const readableStream = new ReadableStream({
start(controller) {
controller.enqueue(uint8Array);
controller.close();
}
});
const reader = readableStream.getReader();
const statusEvent = await Pegasus.splitData({
name: 'report',
stream: reader,
filters: filters,
refColumns: refColumns,
type: 'PDF',
closeByRegisterLimit: 1000000,
cut: 100000,
qttFilePicker: 1,
delimiter: '\n'
});
if (!statusEvent) return;
statusEvent.addEventListener('progress', (data: any) => {
console.log('Data:', data);
});
statusEvent.addEventListener('error', (error: Error) => {
console.log('Error:', error);
});
}
```
## System Requirements
Before using the Pegasus Report Stream application, please make sure your system meets the following requirements:
- Browser compatible with the FileSystemFileHandle feature.
## Contribution
We value and encourage community contribution to the Pegasus Report Stream project. If you wish to contribute, please follow the steps below:
1. Fork the repository.
2. Create a branch for your contribution: `git checkout -b feature/new-feature` or `git checkout -b bug/fix`.
3. Make necessary changes and commit accordingly.
4. Push the branch to your fork: `git push origin feature/new-feature` or `git push origin bug/fix`.
5. Open a pull request in the original repository, explaining your contribution in detail.
6. Wait for feedback from the project team.
## License
The Pegasus Report Stream library is licensed under the MIT License with the following additional restriction, check in the [LICENSE.md](/LICENSE.md)