Skip to content

Commit 9af42e1

Browse files
committed
docs
1 parent 6c0b101 commit 9af42e1

3 files changed

Lines changed: 20 additions & 26 deletions

File tree

index.js

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
/*☭
22
## array-back
33
4-
- **Type:** Package
5-
- **Supported runtimes:** Node.Js >= v12
6-
- **Module type:** JavaScript
7-
- **Exports:** Synchronous Function
8-
94
Takes any input and guarantees an array back.
105
116
- Converts array-like objects (e.g. `arguments`, `Set`) to a real array.
@@ -51,7 +46,9 @@ function isArrayLike (input) {
5146
5247
Takes any input and guarantees an array back.
5348
54-
- **Type:** `function`
49+
- **Type:** Exported Synchronous Function
50+
- **Supported runtimes:** Node.Js >= v12
51+
- **Module type:** JavaScript
5552
- **Returns:** `Array`
5653
5754
¬

readme.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
[![view on npm](https://badgen.net/npm/v/array-back)](https://www.npmjs.org/package/array-back)
22
[![npm module downloads](https://badgen.net/npm/dt/array-back)](https://www.npmjs.org/package/array-back)
33
[![Gihub repo dependents](https://badgen.net/github/dependents-repo/75lb/array-back)](https://github.com/75lb/array-back/network/dependents?dependent_type=REPOSITORY)
4-
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/array-back)](https://github.com/75lb/array-back/network/dependents?dependent_type=PACKAGE)
4+
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/array-back)](https://github.com/75lb/darray-back/network/dependents?dependent_type=PACKAGE)
55
[![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)
66

77
## array-back
88

9-
- **Type:** Package
10-
- **Supported runtimes:** Node.Js >= v12
11-
- **Module type:** JavaScript
12-
- **Exports:** Synchronous Function
13-
149
Takes any input and guarantees an array back.
1510

1611
- Converts array-like objects (e.g. `arguments`, `Set`) to a real array.
@@ -46,7 +41,9 @@ Takes any input and guarantees an array back.
4641

4742
Takes any input and guarantees an array back.
4843

49-
- **Type:** `function`
44+
- **Type:** Exported Synchronous Function
45+
- **Supported runtimes:** Node.Js >= v12
46+
- **Module type:** JavaScript
5047
- **Returns:** `Array`
5148

5249
| Param | Type | Description |
@@ -58,22 +55,22 @@ Takes any input and guarantees an array back.
5855

5956
This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.
6057

61-
Node.js:
58+
From a Node CommonJS module:
6259

6360
```js
64-
const arrayify = require('array-back')
61+
const arrayBack = (await import('array-back')).default
6562
```
6663

67-
Within Node.js with ECMAScript Module support enabled:
64+
From a Node.js JavaScript Module:
6865

6966
```js
70-
import arrayify from 'array-back'
67+
import arrayBack from 'array-back'
7168
```
7269

73-
Within an modern browser ECMAScript Module:
70+
Within an modern browser JavaScript Module:
7471

7572
```js
76-
import arrayify from './node_modules/array-back/index.js'
73+
import arrayBack from './node_modules/array-back/index.js'
7774
```
7875

7976
* * *

readme.template

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![view on npm](https://badgen.net/npm/v/array-back)](https://www.npmjs.org/package/array-back)
22
[![npm module downloads](https://badgen.net/npm/dt/array-back)](https://www.npmjs.org/package/array-back)
33
[![Gihub repo dependents](https://badgen.net/github/dependents-repo/75lb/array-back)](https://github.com/75lb/array-back/network/dependents?dependent_type=REPOSITORY)
4-
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/array-back)](https://github.com/75lb/array-back/network/dependents?dependent_type=PACKAGE)
4+
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/array-back)](https://github.com/75lb/darray-back/network/dependents?dependent_type=PACKAGE)
55
[![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)
66

77
${blocks}
@@ -10,22 +10,22 @@ ${blocks}
1010

1111
This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.
1212

13-
Node.js:
13+
From a Node CommonJS module:
1414

1515
\`\`\`js
16-
const arrayify = require('array-back')
16+
const arrayBack = (await import('array-back')).default
1717
\`\`\`
1818

19-
Within Node.js with ECMAScript Module support enabled:
19+
From a Node.js JavaScript Module:
2020

2121
\`\`\`js
22-
import arrayify from 'array-back'
22+
import arrayBack from 'array-back'
2323
\`\`\`
2424

25-
Within an modern browser ECMAScript Module:
25+
Within an modern browser JavaScript Module:
2626

2727
\`\`\`js
28-
import arrayify from './node_modules/array-back/index.js'
28+
import arrayBack from './node_modules/array-back/index.js'
2929
\`\`\`
3030

3131
* * *

0 commit comments

Comments
 (0)