docs

Author: 75lb

.github/workflows/node.js.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node-version: [12, 14, 16, 18, 20, 22, 24, 25]
+        node-version: [12, 14, 16, 18, 20, 22, 24, 26]
 
     steps:
     - uses: actions/checkout@v6

LICENCE

@@ -1,21 +1,7 @@
-The MIT Licence (MIT)
+The 75lb Licence (75lb)
 
 Copyright (c) 2015-26 Lloyd Brookes <opensource@75lb.com>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+You may use this software without restriction with one condition: you must include the above copyright notice and this permission notice in all copies or substantial portions of the software provided.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+No warranty of any description is provided with this software. Use at your own risk.

index.js

@@ -1,34 +1,42 @@
-/**
- * Takes any input and guarantees an array back.
- *
- * - Converts array-like objects (e.g. `arguments`, `Set`) to a real array.
- * - Converts `undefined` to an empty array.
- * - Converts any another other, singular value (including `null`, objects and iterables other than `Set`) into an array containing that value.
- * - Ignores input which is already an array.
- *
- * @module array-back
- * @example
- * > const arrayify = require('array-back')
- *
- * > arrayify(undefined)
- * []
- *
- * > arrayify(null)
- * [ null ]
- *
- * > arrayify(0)
- * [ 0 ]
- *
- * > arrayify([ 1, 2 ])
- * [ 1, 2 ]
- *
- * > arrayify(new Set([ 1, 2 ]))
- * [ 1, 2 ]
- *
- * > function f(){ return arrayify(arguments); }
- * > f(1,2,3)
- * [ 1, 2, 3 ]
- */
+/*☭
+## array-back
+
+- **Type:** Package
+- **Supported runtimes:** Node.Js >= v12
+- **Module type:** JavaScript
+- **Exports:** Synchronous Function
+
+Takes any input and guarantees an array back.
+
+- Converts array-like objects (e.g. `arguments`, `Set`) to a real array.
+- Converts `undefined` to an empty array.
+- Converts any another other, singular value (including `null`, objects and iterables other than `Set`) into an array containing that value.
+- Ignores input which is already an array.
+
+#### Example
+
+```js
+> const arrayBack = require('array-back')
+> arrayBack(undefined)
+[]
+
+> arrayBack(null)
+[ null ]
+
+> arrayBack(0)
+[ 0 ]
+
+> arrayBack([ 1, 2 ])
+[ 1, 2 ]
+
+> arrayBack(new Set([ 1, 2 ]))
+[ 1, 2 ]
+
+> function f(){ return arrayBack(arguments); }
+> f(1,2,3)
+[ 1, 2, 3 ]
+```
+*/
 
 function isObject (input) {
   return typeof input === 'object' && input !== null
@@ -38,12 +46,28 @@ function isArrayLike (input) {
   return isObject(input) && typeof input.length === 'number'
 }
 
-/**
- * @param {*} - The input value to convert to an array
- * @returns {Array}
- * @alias module:array-back
- */
-function arrayify (input) {
+/*☭
+### arrayBack
+
+Takes any input and guarantees an array back.
+
+- **Type:** `function`
+- **Returns:** `Array`
+
+¬
+  Param
+  Type
+  Description
+¬
+  input
+  `any`
+  The input value to convert to an array
+¬
+
+࿕
+id: Something
+*/
+function arrayBack (input) {
   if (Array.isArray(input)) {
     return input
   } else if (input === undefined) {
@@ -55,4 +79,4 @@ function arrayify (input) {
   }
 }
 
-export default arrayify
+export default arrayBack

package.json

@@ -25,7 +25,7 @@
   ],
   "scripts": {
     "test": "75lb-nature test-runner test.js",
-    "docs": "75lb-nature jsdoc2md -t README.hbs index.js > README.md"
+    "docs": "dcdoc --inputs index.js > README.md"
   },
   "devDependencies": {}
 }

README.md readme.mdREADME.md renamed to readme.md

@@ -4,47 +4,54 @@
 [![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/array-back)](https://github.com/75lb/array-back/network/dependents?dependent_type=PACKAGE)
 [![Node.js CI](https://github.com/75lb/array-back/actions/workflows/node.js.yml/badge.svg)](https://github.com/75lb/array-back/actions/workflows/node.js.yml)
 
-<a name="module_array-back"></a>
-
 ## array-back
+
+- **Type:** Package
+- **Supported runtimes:** Node.Js >= v12
+- **Module type:** JavaScript
+- **Exports:** Synchronous Function
+
 Takes any input and guarantees an array back.
 
 - Converts array-like objects (e.g. `arguments`, `Set`) to a real array.
 - Converts `undefined` to an empty array.
 - Converts any another other, singular value (including `null`, objects and iterables other than `Set`) into an array containing that value.
 - Ignores input which is already an array.
 
-**Example**  
-```js
-> const arrayify = require('array-back')
+#### Example
 
-> arrayify(undefined)
+```js
+> const arrayBack = require('array-back')
+> arrayBack(undefined)
 []
 
-> arrayify(null)
+> arrayBack(null)
 [ null ]
 
-> arrayify(0)
+> arrayBack(0)
 [ 0 ]
 
-> arrayify([ 1, 2 ])
+> arrayBack([ 1, 2 ])
 [ 1, 2 ]
 
-> arrayify(new Set([ 1, 2 ]))
+> arrayBack(new Set([ 1, 2 ]))
 [ 1, 2 ]
 
-> function f(){ return arrayify(arguments); }
+> function f(){ return arrayBack(arguments); }
 > f(1,2,3)
 [ 1, 2, 3 ]
 ```
-<a name="exp_module_array-back--arrayify"></a>
 
-### arrayify(input) ⇒ <code>Array</code> ⏏
-**Kind**: Exported function  
+### arrayBack
+
+Takes any input and guarantees an array back.
+
+- **Type:** `function`
+- **Returns:** `Array`
 
 | Param | Type | Description |
 | --- | --- | --- |
-| input | <code>\*</code> | The input value to convert to an array |
+| input | `any` | The input value to convert to an array |
 
 
 ### Load anywhere
@@ -71,6 +78,5 @@ import arrayify from './node_modules/array-back/index.js'
 
 * * *
 
-&copy; 2015-26 [Lloyd Brookes](https://github.com/75lb) \<opensource@75lb.com\>.
+&copy; 2015-26 [Lloyd Brookes](https://github.com/75lb) <opensource@75lb.com>.
 
-Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

README.hbs readme.templateREADME.hbs renamed to readme.template

@@ -4,32 +4,30 @@
 [![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/array-back)](https://github.com/75lb/array-back/network/dependents?dependent_type=PACKAGE)
 [![Node.js CI](https://github.com/75lb/array-back/actions/workflows/node.js.yml/badge.svg)](https://github.com/75lb/array-back/actions/workflows/node.js.yml)
 
-{{>main}}
+${blocks}
 
 ### Load anywhere
 
 This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.
 
 Node.js:
 
-```js
+\`\`\`js
 const arrayify = require('array-back')
-```
+\`\`\`
 
 Within Node.js with ECMAScript Module support enabled:
 
-```js
+\`\`\`js
 import arrayify from 'array-back'
-```
+\`\`\`
 
 Within an modern browser ECMAScript Module:
 
-```js
+\`\`\`js
 import arrayify from './node_modules/array-back/index.js'
-```
+\`\`\`
 
 * * *
 
 &copy; 2015-26 [Lloyd Brookes](https://github.com/75lb) \<opensource@75lb.com\>.
-
-Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).