markdown-table
Advanced tools
Comparing version 3.0.2 to 3.0.3
/** | ||
* @typedef Options | ||
* Configuration (optional). | ||
* @property {string|null|Array<string|null|undefined>} [align] | ||
* @property {string|null|ReadonlyArray<string|null|undefined>} [align] | ||
* One style for all columns, or styles for their respective columns. | ||
@@ -147,3 +147,3 @@ * Each style is either `'l'` (left), `'r'` (right), or `'c'` (center). | ||
* | ||
* @param {Array<Array<string|null|undefined>>} table | ||
* @param {ReadonlyArray<ReadonlyArray<string|null|undefined>>} table | ||
* Table data (matrix of strings). | ||
@@ -155,3 +155,3 @@ * @param {Options} [options] | ||
export function markdownTable( | ||
table: Array<Array<string | null | undefined>>, | ||
table: ReadonlyArray<ReadonlyArray<string | null | undefined>>, | ||
options?: Options | undefined | ||
@@ -170,3 +170,3 @@ ): string | ||
*/ | ||
align?: string | (string | null | undefined)[] | null | undefined | ||
align?: string | readonly (string | null | undefined)[] | null | undefined | ||
/** | ||
@@ -173,0 +173,0 @@ * Whether to add a space of padding between delimiters and cells. |
/** | ||
* @typedef Options | ||
* Configuration (optional). | ||
* @property {string|null|Array<string|null|undefined>} [align] | ||
* @property {string|null|ReadonlyArray<string|null|undefined>} [align] | ||
* One style for all columns, or styles for their respective columns. | ||
@@ -149,3 +149,3 @@ * Each style is either `'l'` (left), `'r'` (right), or `'c'` (center). | ||
* | ||
* @param {Array<Array<string|null|undefined>>} table | ||
* @param {ReadonlyArray<ReadonlyArray<string|null|undefined>>} table | ||
* Table data (matrix of strings). | ||
@@ -152,0 +152,0 @@ * @param {Options} [options] |
{ | ||
"name": "markdown-table", | ||
"version": "3.0.2", | ||
"version": "3.0.3", | ||
"description": "Generate a markdown (GFM) table", | ||
@@ -33,21 +33,19 @@ "license": "MIT", | ||
"devDependencies": { | ||
"@types/tape": "^4.0.0", | ||
"@types/node": "^18.0.0", | ||
"c8": "^7.0.0", | ||
"chalk": "^5.0.0", | ||
"prettier": "^2.0.0", | ||
"remark-cli": "^10.0.0", | ||
"remark-cli": "^11.0.0", | ||
"remark-preset-wooorm": "^9.0.0", | ||
"rimraf": "^3.0.0", | ||
"strip-ansi": "^7.0.0", | ||
"tape": "^5.0.0", | ||
"type-coverage": "^2.0.0", | ||
"typescript": "^4.0.0", | ||
"xo": "^0.47.0" | ||
"xo": "^0.53.0" | ||
}, | ||
"scripts": { | ||
"prepublishOnly": "npm run build && npm run format", | ||
"build": "rimraf \"*.d.ts\" && tsc && type-coverage", | ||
"prepack": "npm run build && npm run format", | ||
"build": "tsc --build --clean && tsc --build && type-coverage", | ||
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix", | ||
"test-api": "node --conditions development test.js", | ||
"test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api", | ||
"test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api", | ||
"test": "npm run build && npm run format && npm run test-coverage" | ||
@@ -54,0 +52,0 @@ }, |
@@ -44,3 +44,3 @@ # markdown-table | ||
This package is [ESM only][esm]. | ||
In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]: | ||
In Node.js (version 14.14+, 16.0+), install with [npm][]: | ||
@@ -51,13 +51,13 @@ ```sh | ||
In Deno with [Skypack][]: | ||
In Deno with [`esm.sh`][esmsh]: | ||
```js | ||
import {markdownTable} from 'https://cdn.skypack.dev/markdown-table@3?dts' | ||
import {markdownTable} from 'https://esm.sh/markdown-table@3' | ||
``` | ||
In browsers with [Skypack][]: | ||
In browsers with [`esm.sh`][esmsh]: | ||
```html | ||
<script type="module"> | ||
import {markdownTable} from 'https://cdn.skypack.dev/markdown-table@3?min' | ||
import {markdownTable} from 'https://esm.sh/markdown-table@3?bundle' | ||
</script> | ||
@@ -117,3 +117,3 @@ ``` | ||
This package exports the following identifiers: `markdownTable`. | ||
This package exports the identifier `markdownTable`. | ||
There is no default export. | ||
@@ -281,3 +281,3 @@ | ||
This package is fully typed with [TypeScript][]. | ||
It exports additional `Options` type that models its respective interface. | ||
It exports the additional type `Options`. | ||
@@ -287,3 +287,3 @@ ## Compatibility | ||
This package is at least compatible with all maintained versions of Node.js. | ||
As of now, that is Node.js 12.20+, 14.14+, and 16.0+. | ||
As of now, that is Node.js 14.14+ and 16.0+. | ||
It also works in Deno and modern browsers. | ||
@@ -329,3 +329,3 @@ | ||
[skypack]: https://www.skypack.dev | ||
[esmsh]: https://esm.sh | ||
@@ -332,0 +332,0 @@ [license]: license |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
10
0
28027