refactor: move brother_node development artifact to dev/test-nodes subdirectory
Development Artifact Cleanup: ✅ BROTHER_NODE REORGANIZATION: Moved development test node to appropriate location - dev/test-nodes/brother_node/: Moved from root directory for better organization - Contains development configuration, test logs, and test chain data - No impact on production systems - purely development/testing artifact ✅ DEVELOPMENT ARTIFACTS IDENTIFIED: - Chain ID: aitbc-brother-chain (test/development chain) - Ports: 8010 (P2P) and 8011 (RPC) - different from production - Environment: .env file with test configuration - Logs: rpc.log and node.log from development testing session (March 15, 2026) ✅ ROOT DIRECTORY CLEANUP: Removed development clutter from production directory - brother_node/ moved to dev/test-nodes/brother_node/ - Root directory now contains only production-ready components - Development artifacts properly organized in dev/ subdirectory DIRECTORY STRUCTURE IMPROVEMENT: 📁 dev/test-nodes/: Development and testing node configurations 🏗️ Root Directory: Clean production structure with only essential components 🧪 Development Isolation: Test environments separated from production BENEFITS: ✅ Clean Production Directory: No development artifacts in root ✅ Better Organization: Development nodes grouped in dev/ subdirectory ✅ Clear Separation: Production vs development environments clearly distinguished ✅ Maintainability: Easier to identify and manage development components RESULT: Successfully moved brother_node development artifact to dev/test-nodes/ subdirectory, cleaning up the root directory while preserving development testing environment for future use.
This commit is contained in:
204
dev/env/node_modules/json-stream-stringify/README.md
generated
vendored
Executable file
204
dev/env/node_modules/json-stream-stringify/README.md
generated
vendored
Executable file
@@ -0,0 +1,204 @@
|
||||
# JSON Stream Stringify
|
||||
|
||||
[![NPM version][npm-image]][npm-url]
|
||||
[![NPM Downloads][downloads-image]][downloads-url]
|
||||
[![Build Status][travis-image]][travis-url]
|
||||
[![Coverage Status][coveralls-image]][coveralls-url]
|
||||
[![License][license-image]](LICENSE)
|
||||
[![Donate][donate-image]][donate-url]
|
||||
|
||||
JSON Stringify as a Readable Stream with rescursive resolving of any readable streams and Promises.
|
||||
|
||||
## Important and Breaking Changes in v3.1.0
|
||||
|
||||
- Completely rewritten from scratch - again
|
||||
- Buffer argument added (Stream will not output data untill buffer size is reached - improves speed)
|
||||
- Dropped support for node <7.10.1 - async supporting environment now required
|
||||
|
||||
## Main Features
|
||||
|
||||
- Promises are rescursively resolved and the result is piped through JsonStreamStringify
|
||||
- Streams (Object mode) are recursively read and output as arrays
|
||||
- Streams (Non-Object mode) are output as a single string
|
||||
- Output is streamed optimally with as small chunks as possible
|
||||
- Cycling of cyclical structures and dags using [Douglas Crockfords cycle algorithm](https://github.com/douglascrockford/JSON-js)*
|
||||
- Great memory management with reference release after processing and WeakMap/Set reference handling
|
||||
- Optimal stream pressure handling
|
||||
- Tested and runs on ES5**, ES2015**, ES2016 and later
|
||||
- Bundled as UMD and Module
|
||||
|
||||
\* Off by default since v2
|
||||
\** With [polyfills](#usage)
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
npm install --save json-stream-stringify
|
||||
|
||||
# Optional if you need polyfills
|
||||
# Make sure to include these if you target NodeJS <=v6 or browsers
|
||||
npm install --save @babel/polyfill @babel/runtime
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Using Node v8 or later with ESM / Webpack / Browserify / Rollup
|
||||
|
||||
### No Polyfills, TS / ESM
|
||||
|
||||
```javascript
|
||||
import { JsonStreamStringify } from 'json-stream-stringify';
|
||||
```
|
||||
|
||||
### Polyfilled, TS / ESM
|
||||
|
||||
install @babel/runtime-corejs3 and corejs@3
|
||||
|
||||
```javascript
|
||||
import { JsonStreamStringify } from 'json-stream-stringify/polyfill';
|
||||
import { JsonStreamStringify } from 'json-stream-stringify/module.polyfill'; // force ESM
|
||||
```
|
||||
|
||||
### Using Node >=8 / Other ES2015 UMD/CommonJS environments
|
||||
|
||||
```javascript
|
||||
const { JsonStreamStringify } = require('json-stream-stringify'); // let module resolution decide UMD or CJS
|
||||
const { JsonStreamStringify } = require('json-stream-stringify/umd'); // force UMD
|
||||
const { JsonStreamStringify } = require('json-stream-stringify/cjs'); // force CJS
|
||||
```
|
||||
|
||||
### Using Node <=6 / Other ES5 UMD/CommonJS environments
|
||||
|
||||
```javascript
|
||||
const { JsonStreamStringify } = require('json-stream-stringify/polyfill');
|
||||
const { JsonStreamStringify } = require('json-stream-stringify/umd/polyfill');
|
||||
const { JsonStreamStringify } = require('json-stream-stringify/cjs/polyfill');
|
||||
```
|
||||
|
||||
**Note:** This library is primarily written for LTS versions of NodeJS. Other environments are not tested.
|
||||
**Note on non-NodeJS usage:** This module depends on node streams library. Any Streams3 compatible implementation should work - as long as it exports a `Readable` class, with instances that looks like readable streams.
|
||||
**Note on Polyfills:** I have taken measures to minify global pollution of polyfills but this library **does not load polyfills by default** because the polyfills modify native object prototypes and it goes against the [W3C recommendations](https://www.w3.org/2001/tag/doc/polyfills/#advice-for-library-and-framework-authors).
|
||||
|
||||
## API
|
||||
|
||||
### `new JsonStreamStringify(value[, replacer[, spaces[, cycle[, bufferSize=512]]]])`
|
||||
|
||||
Streaming conversion of ``value`` to JSON string.
|
||||
|
||||
#### Parameters
|
||||
|
||||
- ``value`` ``Any``
|
||||
Data to convert to JSON.
|
||||
|
||||
- ``replacer`` Optional ``Function(key, value)`` or ``Array``
|
||||
As a function the returned value replaces the value associated with the key. [Details](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
|
||||
As an array all other keys are filtered. [Details](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Example_with_an_array)
|
||||
|
||||
- ``spaces`` Optional ``String`` or ``Number``
|
||||
A String or Number object that's used to insert white space into the output JSON string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space. If this is a String, the string is used as white space. If this parameter is not recognized as a finite number or valid string, no white space is used.
|
||||
|
||||
- ``cycle`` Optional ``Boolean``
|
||||
``true`` enables cycling of cyclical structures and dags.
|
||||
To restore cyclical structures; use [Crockfords Retrocycle method](https://github.com/douglascrockford/JSON-js) on the parsed object (not included in this module).
|
||||
|
||||
#### Returns
|
||||
|
||||
- ``JsonStreamStringify`` object that exposes a [Streams3 interface](https://nodejs.org/api/stream.html#stream_class_stream_readable).
|
||||
|
||||
### jsonStreamStringify#path
|
||||
|
||||
Get current path begin serialized.
|
||||
|
||||
#### Returns
|
||||
|
||||
- ``Array[String, Number]``
|
||||
Array of path Strings (keys of objects) and Numbers (index into arrays).
|
||||
Can be transformed into an mpath with ``.join('.')``.
|
||||
Useful in conjunction with ``.on('error', ...)``, for figuring out what path may have caused the error.
|
||||
|
||||
## Complete Example
|
||||
|
||||
```javascript
|
||||
const { JsonStreamStringify } = require('json-stream-stringify');
|
||||
|
||||
const jsonStream = new JsonStreamStringify({
|
||||
// Promises and Streams may resolve more promises and/or streams which will be consumed and processed into json output
|
||||
aPromise: Promise.resolve(Promise.resolve("text")),
|
||||
aStream: ReadableObjectStream({a:1}, 'str'),
|
||||
arr: [1, 2, Promise.resolve(3), Promise.resolve([4, 5]), ReadableStream('a', 'b', 'c')],
|
||||
date: new Date(2016, 0, 2)
|
||||
});
|
||||
jsonStream.once('error', () => console.log('Error at path', jsonStream.stack.join('.')));
|
||||
jsonStream.pipe(process.stdout);
|
||||
```
|
||||
|
||||
Output (each line represents a write from jsonStreamStringify)
|
||||
|
||||
```text
|
||||
{
|
||||
"aPromise":
|
||||
"text"
|
||||
"aStream":
|
||||
[
|
||||
{
|
||||
"a":
|
||||
1
|
||||
}
|
||||
,
|
||||
"str"
|
||||
]
|
||||
"arr":
|
||||
[
|
||||
1
|
||||
,
|
||||
2
|
||||
,
|
||||
3
|
||||
,
|
||||
[
|
||||
4
|
||||
,
|
||||
5
|
||||
]
|
||||
,
|
||||
"
|
||||
a
|
||||
b
|
||||
c
|
||||
"
|
||||
],
|
||||
"date":
|
||||
"2016-01-01T23:00:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
## Practical Example with Express + Mongoose
|
||||
|
||||
```javascript
|
||||
app.get('/api/users', (req, res, next) => {
|
||||
res.type('json'); // Required for proper handling by test frameworks and some clients
|
||||
new JsonStreamStringify(Users.find().stream()).pipe(res);
|
||||
});
|
||||
```
|
||||
|
||||
### Why do I not get proper typings? (Missing .on(...), etc.)
|
||||
|
||||
install ``@types/readable-stream`` or ``@types/node`` or create your own ``stream.d.ts`` that exports a ``Readable`` class.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
Copyright (c) 2016 Faleij [faleij@gmail.com](mailto:faleij@gmail.com)
|
||||
|
||||
[npm-image]: http://img.shields.io/npm/v/json-stream-stringify.svg
|
||||
[npm-url]: https://npmjs.org/package/json-stream-stringify
|
||||
[downloads-image]: https://img.shields.io/npm/dm/json-stream-stringify.svg
|
||||
[downloads-url]: https://npmjs.org/package/json-stream-stringify
|
||||
[travis-image]: https://travis-ci.org/Faleij/json-stream-stringify.svg?branch=master
|
||||
[travis-url]: https://travis-ci.org/Faleij/json-stream-stringify
|
||||
[coveralls-image]: https://coveralls.io/repos/Faleij/json-stream-stringify/badge.svg?branch=master&service=github
|
||||
[coveralls-url]: https://coveralls.io/github/Faleij/json-stream-stringify?branch=master
|
||||
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg
|
||||
[donate-image]: https://img.shields.io/badge/Donate-PayPal-green.svg
|
||||
[donate-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=faleij%40gmail%2ecom&lc=GB&item_name=faleij&item_number=jsonStreamStringify¤cy_code=SEK&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted
|
||||
Reference in New Issue
Block a user