Auto-generated commit

parse-ndjson/README.md

@@ -0,0 +1,176 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# parseNDJSON
+
+> Parse a string containing serialized newline-delimited [JSON][json] (NDJSON).
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var parseNDJSON = require( '@stdlib/utils/parse-ndjson' );
+```
+
+#### parseNDJSON( str\[, reviver] )
+
+Parses a `string` as `newline-delimited JSON`.
+
+```javascript
+var out = parseNDJSON( '{"beep":"boop"}\n{"example":42}' );
+// returns [ { 'beep': 'boop' }, { 'example': 42 } ]
+```
+
+To transform the `string` being parsed, provide a `reviver`.
+
+```javascript
+function reviver( key, value ) {
+    if ( key === '' || key === 'beep' ) {
+        return ( typeof value === 'string' ) ? value.toUpperCase() : value;
+    }
+    return ( typeof value === 'number' ) ? value * 2 : value;
+}
+
+var str = '{"beep":"boop"}\n{"value": 20}\n{"numbers": [1,2,3]}';
+var out = parseNDJSON( str, reviver );
+// returns [ { 'beep' : 'BOOP' }, { 'value': 40 }, { 'numbers': [ 2, 4, 6 ] } ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   In contrast to the native [`JSON.parse()`][json-parse], this implementation parses `string` as `newline-delimited JSON` and returns an array of parsed JSONs.
+
+    ```javascript
+    var out = JSON.parse( '{"beep":"boop"}\n{"foo":"baz"}' );
+    // throws <SyntaxError>
+
+    out = parseNDJSON( '{"beep":"boop"}\n{"foo":"baz"}' );
+    // returns [ { 'beep': 'boop' }, { 'foo': 'baz' } ]
+    ```
+
+
+-   In contrast to the native [`JSON.parse()`][json-parse], this implementation throws a TypeError if provided any value which is not a `string`.
+
+    ```javascript
+    var out = JSON.parse( null );
+    // returns null
+
+    out = parseNDJSON( null );
+    // throws <TypeError>
+    ```
+
+
+-   In contrast to the native [`JSON.parse()`][json-parse], this implementation does **not** throw a SyntaxError if unable to parse a string as newline-delimited JSON.
+
+    ```javascript
+    var out = parseNDJSON( '{"beep":boop}' );
+    // returns <SyntaxError>
+
+    out = JSON.parse( '{"beep":boop}' );
+    // throws <SyntaxError>
+    ```
+
+
+-   In contrast to the native [`JSON.parse()`][json-parse], this implementation throws a TypeError if provided a reviver argument which is not a function.
+
+    ```javascript
+    var out = JSON.parse( '{"a":"b"}', [] );
+    // returns { 'a': 'b' }
+
+    out = parseNDJSON( '{"a":"b"}', [] );
+    // throws <TypeError>
+    ```
+
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var parseNDJSON = require( '@stdlib/utils/parse-ndjson' );
+
+var out = parseNDJSON( '{"name":"John"}\n{"name":"Doe"}' );
+// returns [ { 'name': 'John' }, { 'name': 'Doe' } ]
+
+function reviver( key, value ) {
+    if ( key === 'name' ) {
+        return value.toUpperCase();
+    }
+    return value;
+}
+
+out = parseNDJSON( '{"name":"John"}\n{"name":"Doe"}', reviver );
+// returns [ { 'name': 'JOHN' }, { 'name': 'DOE' } ]
+
+out = parseNDJSON( '{"name":John}\n{"name":Doe}' );
+// returns <SyntaxError>
+
+out = parseNDJSON( ' ' );
+// returns []
+
+out = parseNDJSON( '{}' );
+// returns [ {} ]
+
+out = parseNDJSON( '{"name":"Eve"}\n42\ntrue\n[1,2,3]' );
+// returns [ { 'name': 'Eve' }, 42, true, [ 1, 2, 3 ] ]
+
+out = parseNDJSON( '{"name":"John"}\r\n{"name":"Doe"}' );
+// returns [ { 'name': 'John' }, { 'name': 'Doe' } ]
+
+out = parseNDJSON( '{"name":"John"}\n{"name":"Doe"}\n' );
+// returns [ { 'name': 'John' }, { 'name': 'Doe' } ]
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[json]: http://www.json.org/
+
+[json-parse]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse
+
+</section>
+
+<!-- /.links -->

parse-ndjson/benchmark/benchmark.js

@@ -0,0 +1,61 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var fromCodePoint = require( '@stdlib/string/from-code-point' );
+var pkg = require( './../package.json' ).name;
+var parseNDJSON = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var str;
+	var out;
+	var i;
+	var j;
+
+	b.tic();
+
+	for ( i = 0; i < b.iterations; i++ ) {
+		// Generate an NDJSON string with a changing property key in each line:
+		str = '{"beep":"boop","'+fromCodePoint( 97 + (i%26) ) + '":true}\n{"example":' + i + '}';
+		out = parseNDJSON( str );
+
+		if ( out !== out ) {
+			b.fail( 'should return an array of JSON objects' );
+		}
+	}
+
+	b.toc();
+
+	for ( j = 0; j < out.length; j++ ) {
+		if ( out[j] instanceof Error ) {
+			b.fail( 'should return an array of JSON objects' );
+		}
+	}
+
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+// TODO: Add benchmarks with different sized NDJSON strings

parse-ndjson/docs/repl.txt

@@ -0,0 +1,45 @@
+
+{{alias}}( str[, reviver] )
+    Attempts to parse a string as newline-delimited JSON (NDJSON).
+
+    Function behavior differs from `JSON.parse()` as follows:
+
+    - Returns array of parsed JSON
+    - Throws a `TypeError` if provided any value which is not a string.
+    - Returns a `SyntaxError` if unable to parse a string as NDJSON.
+    - Throws a `TypeError` if provided a `reviver` argument which 
+    is not a function.
+
+    Parameters
+    ----------
+    str: string
+        String to parse as newline-delimited JSON.
+
+    reviver: Function (optional)
+        Transformation function.
+
+    Returns
+    -------
+    out: Array | Error
+        Array of parsed values or an error.
+
+    Examples
+    --------
+    > var obj = '{"beep":"boop"}\n{"example":42}\n{"data":[1,2,3]}';
+    > var result = {{alias}}( obj )
+    [ { 'beep': 'boop' }, { 'example': 42 }, { 'data': [ 1, 2, 3 ] } ]
+
+    // Provide a reviver:
+    > function reviver( key, value ) {
+    ...     if ( key === '' || key === 'beep' ) {
+    ...         return ( typeof value === 'string' ) 
+    ...         ? value.toUpperCase() : value;
+    ...     };
+    ...     return typeof value === 'number' ? value * 2 : value;
+    ... };
+    > var ndjsonString = '{"beep":"boop"}\n{"example":42}\n{"data":[1,2,3]}';
+    > var resultWithReviver = {{alias}}( ndjsonString, reviver )
+    [ { 'beep': 'boop' }, { 'example': 84 }, { 'data': [ 2, 4, 6 ] } ]
+
+    See Also
+    --------

parse-ndjson/docs/types/index.d.ts

@@ -0,0 +1,38 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Parses a string as newline-delimited JSON (NDJSON).
+*
+* @param str - input string containing NDJSON
+* @param reviver - transformation function applied to each line
+* @returns array of parsed values or an error
+*
+* @example
+* var arr = parseNDJSON( '{"beep":"boop"}\\n{"example":42}\\n{"data":[1,2,3]}' );
+* // returns [ { 'beep': 'boop' }, { 'example': 42 }, { 'data': [ 1, 2, 3 ] } ]
+*/
+
+declare function parseNDJSON( str: string, reviver?: Function ): Array<any> | Error;
+
+
+// EXPORTS //
+
+export = parseNDJSON;

parse-ndjson/docs/types/test.ts

@@ -0,0 +1,54 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import parseNDJSON = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of parsed values...
+{
+	const validNDJSON = '{"beep":"boop"}\n{"example":42}\n{"data":[1,2,3]}';
+	parseNDJSON( validNDJSON ); // $ExpectType any[] | Error
+}
+
+// The function does not compile if the argument is a value other than a string...
+{
+	parseNDJSON( true ); // $ExpectError
+	parseNDJSON( false ); // $ExpectError
+	parseNDJSON( 5 ); // $ExpectError
+	parseNDJSON( [] ); // $ExpectError
+	parseNDJSON( {} ); // $ExpectError
+	parseNDJSON( ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if the second argument is a value other than a function...
+{
+	parseNDJSON( '{"beep":"boop"}\n{"example":42}', true ); // $ExpectError
+	parseNDJSON( '{"beep":"boop"}\n{"example":42}', false ); // $ExpectError
+	parseNDJSON( '{"beep":"boop"}\n{"example":42}', 5 ); // $ExpectError
+	parseNDJSON( '{"beep":"boop"}\n{"example":42}', [] ); // $ExpectError
+	parseNDJSON( '{"beep":"boop"}\n{"example":42}', {} ); // $ExpectError
+	parseNDJSON( '{"beep":"boop"}\n{"example":42}', 'baz' ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	parseNDJSON( ); // $ExpectError
+	parseNDJSON( '{"beep":"boop"}', 'baz', 'foo' ); // $ExpectError
+}