Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
ansi-escape-sequences
Advanced tools
ansi-escape-sequences - npm Package Compare versions
Comparing version 1.0.1 to 1.0.2
| { | ||
| "name": "ansi-escape-sequences", | ||
| "author": "Lloyd Brookes <75pound@gmail.com>", | ||
| "version": "1.0.1", | ||
| "version": "1.0.2", | ||
| "description": "A simple library containing all known terminal ansi escape codes and sequences. Useful for adding colour to your command-line output or building a dynamic text user interface.", | ||
@@ -26,3 +26,3 @@ "repository": "https://github.com/75lb/ansi-escape-sequences.git", | ||
| "lint": "jshint lib/*.js bin/*.js test/*.js; echo", | ||
| "docs": "jsdoc2md -d 1 -l js -t jsdoc2md/README.hbs lib/*.js > README.md; echo" | ||
| "docs": "jsdoc2md -d 1 -l js --no-gfm -t jsdoc2md/README.hbs lib/*.js > README.md; echo" | ||
| }, | ||
@@ -29,0 +29,0 @@ "dependencies": { |
258
README.md
@@ -38,24 +38,52 @@ [](https://www.npmjs.org/package/ansi-escape-sequences) | ||
| | Name | Type | | ||
| | --- | --- | | ||
| | reset | <code>string</code> | | ||
| | bold | <code>string</code> | | ||
| | italic | <code>string</code> | | ||
| | underline | <code>string</code> | | ||
| | fontDefault | <code>string</code> | | ||
| | font2 | <code>string</code> | | ||
| | font3 | <code>string</code> | | ||
| | font4 | <code>string</code> | | ||
| | font5 | <code>string</code> | | ||
| | font6 | <code>string</code> | | ||
| | imageNegative | <code>string</code> | | ||
| | imagePositive | <code>string</code> | | ||
| | black | <code>string</code> | | ||
| | red | <code>string</code> | | ||
| | green | <code>string</code> | | ||
| | yellow | <code>string</code> | | ||
| | blue | <code>string</code> | | ||
| | magenta | <code>string</code> | | ||
| | cyan | <code>string</code> | | ||
| | white | <code>string</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Name</th><th>Type</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>reset</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>bold</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>italic</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>underline</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>fontDefault</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>font2</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>font3</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>font4</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>font5</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>font6</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>imageNegative</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>imagePositive</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>black</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>red</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>green</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>yellow</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>blue</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>magenta</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>cyan</td><td><code>string</code></td> | ||
| </tr><tr> | ||
| <td>white</td><td><code>string</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -75,5 +103,14 @@ **Example** | ||
| | Type | Description | | ||
| | --- | --- | | ||
| | <code>string</code> \| <code>Array.<string></code> | a sgr effect, or list of effects | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Type</th><th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td><code>string</code> | <code>Array.<string></code></td><td>a sgr effect, or list of effects</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -91,6 +128,16 @@ **Example** | ||
| | Type | Description | | ||
| | --- | --- | | ||
| | <code>string</code> | the string to format | | ||
| | <code>Array.<string></code> | a list of sgr effects to add | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Type</th><th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td><code>string</code></td><td>the string to format</td> | ||
| </tr><tr> | ||
| <td><code>Array.<string></code></td><td>a list of sgr effects to add</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -123,5 +170,14 @@ **Example** | ||
| | Param | Type | Default | | ||
| | --- | --- | --- | | ||
| | [lines] | <code>number</code> | <code>1</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Default</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>[lines]</td><td><code>number</code></td><td><code>1</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -132,5 +188,14 @@ <a name="module_ansi-escape-sequences.cursor.down"></a> | ||
| | Param | Type | Default | | ||
| | --- | --- | --- | | ||
| | [lines] | <code>number</code> | <code>1</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Default</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>[lines]</td><td><code>number</code></td><td><code>1</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -141,5 +206,14 @@ <a name="module_ansi-escape-sequences.cursor.forward"></a> | ||
| | Param | Type | Default | | ||
| | --- | --- | --- | | ||
| | [lines] | <code>number</code> | <code>1</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Default</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>[lines]</td><td><code>number</code></td><td><code>1</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -150,5 +224,14 @@ <a name="module_ansi-escape-sequences.cursor.back"></a> | ||
| | Param | Type | Default | | ||
| | --- | --- | --- | | ||
| | [lines] | <code>number</code> | <code>1</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Default</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>[lines]</td><td><code>number</code></td><td><code>1</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -159,5 +242,14 @@ <a name="module_ansi-escape-sequences.cursor.nextLine"></a> | ||
| | Param | Type | Default | | ||
| | --- | --- | --- | | ||
| | [lines] | <code>number</code> | <code>1</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Default</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>[lines]</td><td><code>number</code></td><td><code>1</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -168,5 +260,14 @@ <a name="module_ansi-escape-sequences.cursor.previousLine"></a> | ||
| | Param | Type | Default | | ||
| | --- | --- | --- | | ||
| | [lines] | <code>number</code> | <code>1</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Default</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>[lines]</td><td><code>number</code></td><td><code>1</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -177,5 +278,14 @@ <a name="module_ansi-escape-sequences.cursor.horizontalAbsolute"></a> | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | n | <code>number</code> | column number | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>n</td><td><code>number</code></td><td>column number</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -186,6 +296,16 @@ <a name="module_ansi-escape-sequences.cursor.position"></a> | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | n | <code>number</code> | row number | | ||
| | m | <code>number</code> | column number | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th><th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>n</td><td><code>number</code></td><td>row number</td> | ||
| </tr><tr> | ||
| <td>m</td><td><code>number</code></td><td>column number</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -205,5 +325,14 @@ <a name="module_ansi-escape-sequences.erase"></a> | ||
| | Param | Type | | ||
| | --- | --- | | ||
| | n | <code>number</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>n</td><td><code>number</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -214,5 +343,14 @@ <a name="module_ansi-escape-sequences.erase.inLine"></a> | ||
| | Param | Type | | ||
| | --- | --- | | ||
| | n | <code>number</code> | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Param</th><th>Type</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>n</td><td><code>number</code></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
@@ -219,0 +357,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by11.88%
20135
- Number of lines in readme file
- increased by65.4%
349
No dependency changes