it-ndjson - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

dist/src/index.d.ts

@@ -0,3 +1,26 @@
+/**
+ * @packageDocumentation
+ *
+ * Turn (async)iterable values into JSON and back again.
+ *
+ * @example
+ *
+ * ```javascript
+ * import ndjson from 'it-ndjson'
+ * import all from 'it-all'
+ *
+ * // This can also be an iterator, async iterator, generator, etc
+ * const values = [0, 1, 2, 3, 4]
+ *
+ * const arr = await all(ndjson.stringify(values))
+ *
+ * console.info(arr) // '0\n', '1\n', '2\n', '3\n', '4\n'
+ *
+ * const res = await all(ndjson.parse(arr))
+ *
+ * console.info(res) // [0, 1, 2, 3, 4]
+ * ```
+ */
 export { default as parse } from './parse.js';
 export { default as stringify } from './stringify.js';
 //# sourceMappingURL=index.d.ts.map

dist/src/index.js

@@ -0,3 +1,26 @@
+/**
+ * @packageDocumentation
+ *
+ * Turn (async)iterable values into JSON and back again.
+ *
+ * @example
+ *
+ * ```javascript
+ * import ndjson from 'it-ndjson'
+ * import all from 'it-all'
+ *
+ * // This can also be an iterator, async iterator, generator, etc
+ * const values = [0, 1, 2, 3, 4]
+ *
+ * const arr = await all(ndjson.stringify(values))
+ *
+ * console.info(arr) // '0\n', '1\n', '2\n', '3\n', '4\n'
+ *
+ * const res = await all(ndjson.parse(arr))
+ *
+ * console.info(res) // [0, 1, 2, 3, 4]
+ * ```
+ */
 export { default as parse } from './parse.js';
 export { default as stringify } from './stringify.js';
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "it-ndjson",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Parse iterators as ndjson and transform iterators to ndjson",
@@ -32,2 +32,3 @@ "author": "Alex Potsides <[e-mail]>",
     "parserOptions": {
+      "project": true,
       "sourceType": "module"
@@ -135,3 +136,3 @@ }
   "devDependencies": {
-    "aegir": "^40.0.11",
+    "aegir": "^41.1.9",
     "buffer": "^6.0.3",
@@ -138,0 +139,0 @@ "it-all": "^3.0.0"

README.md

@@ -1,3 +0,1 @@
-# it-ndjson <!-- omit in toc -->
-
 [![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
@@ -8,26 +6,8 @@ [![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
-## Table of contents <!-- omit in toc -->
+# About
 
-- [Install](#install)
-  - [Browser `<script>` tag](#browser-script-tag)
-- [Usage](#usage)
-- [License](#license)
-- [Contribution](#contribution)
+Turn (async)iterable values into JSON and back again.
 
-## Install
+## Example
 
-```console
-$ npm i it-ndjson
-```
-
-### Browser `<script>` tag
-
-Loading this module through a script tag will make it's exports available as `ItNdjson` in the global namespace.
-
-```html
-<script src="https://unpkg.com/it-ndjson/dist/index.min.js"></script>
-```
-
-## Usage
-
 ```javascript
@@ -49,4 +29,18 @@ import ndjson from 'it-ndjson'
 
-## License
+# Install
 
+```console
+$ npm i it-ndjson
+```
+
+## Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `ItNdjson` in the global namespace.
+
+```html
+<script src="https://unpkg.com/it-ndjson/dist/index.min.js"></script>
+```
+
+# License
+
 Licensed under either of
@@ -57,4 +51,4 @@
 
-## Contribution
+# Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

src/index.ts

@@ -0,2 +1,26 @@
+/**
+ * @packageDocumentation
+ *
+ * Turn (async)iterable values into JSON and back again.
+ *
+ * @example
+ *
+ * ```javascript
+ * import ndjson from 'it-ndjson'
+ * import all from 'it-all'
+ *
+ * // This can also be an iterator, async iterator, generator, etc
+ * const values = [0, 1, 2, 3, 4]
+ *
+ * const arr = await all(ndjson.stringify(values))
+ *
+ * console.info(arr) // '0\n', '1\n', '2\n', '3\n', '4\n'
+ *
+ * const res = await all(ndjson.parse(arr))
+ *
+ * console.info(res) // [0, 1, 2, 3, 4]
+ * ```
+ */
+
 export { default as parse } from './parse.js'
 export { default as stringify } from './stringify.js'

No alert changes

Improved metrics

Total package byte prevSize

12356

increased by13.24%

Lines of code

134

increased by106.15%

Worsened metrics

Number of lines in readme file

52

decreased by-10.34%

No dependency changes