content-entry - npm Package Compare versions

Comparing version 2.6.1 to 2.6.2

package.json

 {
   "name": "content-entry",
-  "version": "2.6.1",
+  "version": "2.6.2",
   "publishConfig": {
@@ -9,3 +9,3 @@ "access": "public"
   "exports": {
-    ".": "./src/entry.mjs"
+    ".": "./src/index.mjs"
   },
@@ -31,14 +31,14 @@ "description": "content entries for content containers (aka files)",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 2m tests/*.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
-    "docs": "documentation readme ./src/entry.mjs --section=API",
+    "docs": "documentation readme --section=API ./src/**/*.mjs",
     "lint": "npm run lint:docs",
-    "lint:docs": "documentation lint ./src/entry.mjs"
+    "lint:docs": "documentation lint ./src/**/*.mjs"
   },
   "devDependencies": {
-    "ava": "^3.14.0",
-    "c8": "^7.3.5",
+    "ava": "^3.15.0",
+    "c8": "^7.4.0",
     "documentation": "github:arlac77/documentation",
-    "semantic-release": "^17.3.0"
+    "semantic-release": "^17.3.3"
   },
   "engines": {
-    "node": ">=12.19.0"
+    "node": ">=12.20.1"
   },
@@ -45,0 +45,0 @@ "repository": {

README.md

@@ -6,3 +6,3 @@ [![npm](https://img.shields.io/npm/v/content-entry.svg)](https://www.npmjs.com/package/content-entry)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/content-entry.svg?style=flat-square)](https://github.com/arlac77/content-entry/issues)
-[![Build Action Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fcontent-entry%2Fbadge&style=flat)](https://actions-badge.atrox.dev/arlac77/content-entry/goto)
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fcontent-entry%2Fbadge&style=flat)](https://actions-badge.atrox.dev/arlac77/content-entry/goto)
 [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
@@ -23,5 +23,4 @@ [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
--   [ContentEntry](#contententry)
-    -   [equalsContent](#equalscontent)
-        -   [Parameters](#parameters)
+-   [CollectionEntryMixin](#collectionentrymixin)
+    -   [Parameters](#parameters)
 -   [BaseEntry](#baseentry)
@@ -34,20 +33,21 @@ -   [Parameters](#parameters-1)
     -   [isDeleted](#isdeleted)
--   [CollectionEntryMixin](#collectionentrymixin)
+-   [BufferContentEntryMixin](#buffercontententrymixin)
     -   [Parameters](#parameters-2)
--   [EmptyContentEntry](#emptycontententry)
+    -   [Properties](#properties-1)
+-   [BufferContentEntry](#buffercontententry)
+    -   [Parameters](#parameters-3)
+-   [ContentEntry](#contententry)
+    -   [equalsContent](#equalscontent)
+        -   [Parameters](#parameters-4)
 -   [DeletedContentEntry](#deletedcontententry)
     -   [isDeleted](#isdeleted-1)
--   [BufferContentEntryMixin](#buffercontententrymixin)
-    -   [Parameters](#parameters-3)
-    -   [Properties](#properties-1)
--   [StreamContentEntryMixin](#streamcontententrymixin)
-    -   [Parameters](#parameters-4)
--   [StringContentEntryMixin](#stringcontententrymixin)
+-   [EmptyContentEntry](#emptycontententry)
+-   [ReadableStreamContentEntry](#readablestreamcontententry)
     -   [Parameters](#parameters-5)
     -   [Properties](#properties-2)
--   [ReadableStreamContentEntry](#readablestreamcontententry)
+-   [StreamContentEntryMixin](#streamcontententrymixin)
     -   [Parameters](#parameters-6)
+-   [StringContentEntryMixin](#stringcontententrymixin)
+    -   [Parameters](#parameters-7)
     -   [Properties](#properties-3)
--   [BufferContentEntry](#buffercontententry)
-    -   [Parameters](#parameters-7)
 -   [StringContentEntry](#stringcontententry)
@@ -57,22 +57,14 @@ -   [Parameters](#parameters-8)
 
-## ContentEntry
+## CollectionEntryMixin
 
-**Extends BaseEntry**
+Brings directory attributes to entries.
 
-General content access entries
+### Parameters
 
-### equalsContent
+-   `superclass`  
 
-compare content against other entry
-
-#### Parameters
-
--   `other` **Entry** 
-
-Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if other has the same content (bitwise)
-
 ## BaseEntry
 
-Representation of one file or directory entry
-All names are absolute (no leading '/') the group seperator is '/'
+Representation of one file or directory entry.
+All names are absolute (no leading '/') the group seperator is '/'.
 
@@ -105,5 +97,5 @@ ### Parameters
 
-## CollectionEntryMixin
+## BufferContentEntryMixin
 
-Brings directory attributes to entries.
+Content entries where a Buffer is the primary data representation.
 
@@ -114,52 +106,49 @@ ### Parameters
 
-## EmptyContentEntry
+### Properties
 
-**Extends ContentEntry**
+-   `buffer` **[Buffer](https://nodejs.org/api/buffer.html)** 
 
-Represents a entry without content (content length = 0).
+## BufferContentEntry
 
-## DeletedContentEntry
+**Extends BufferContentEntryMixin(ContentEntry)**
 
-**Extends EmptyContentEntry**
+### Parameters
 
-Represents a deleted entry.
+-   `name`  
+-   `buffer`  
 
-### isDeleted
+## ContentEntry
 
-We are always deleted
+**Extends BaseEntry**
 
-Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
+General content access entries.
 
-## BufferContentEntryMixin
+### equalsContent
 
-Content entries where a Buffer is the primary data representation.
+Compare content against other entry.
 
-### Parameters
+#### Parameters
 
--   `superclass`  
+-   `other` **Entry** 
 
-### Properties
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if other has the same content (bitwise)
 
--   `buffer` **[Buffer](https://nodejs.org/api/buffer.html)** 
+## DeletedContentEntry
 
-## StreamContentEntryMixin
+**Extends EmptyContentEntry**
 
-Content entries where a stream is the primary data representation.
+Represents a deleted entry.
 
-### Parameters
+### isDeleted
 
--   `superclass`  
+We are always deleted
 
-## StringContentEntryMixin
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
 
-Content entries where a string is the primary data representation.
+## EmptyContentEntry
 
-### Parameters
+**Extends ContentEntry**
 
--   `superclass`  
+Represents a entry without content (content length = 0).
 
-### Properties
-
--   `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
 ## ReadableStreamContentEntry
@@ -181,11 +170,22 @@
 
-## BufferContentEntry
+## StreamContentEntryMixin
 
-**Extends BufferContentEntryMixin(ContentEntry)**
+Content entries where a stream is the primary data representation.
 
 ### Parameters
 
--   `name`  
--   `buffer`  
+-   `superclass`  
 
+## StringContentEntryMixin
+
+Content entries where a string is the primary data representation.
+
+### Parameters
+
+-   `superclass`  
+
+### Properties
+
+-   `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ## StringContentEntry
@@ -192,0 +192,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

17742

-0.01%

No dependency changes