Ignore:
Timestamp:
11/25/21 22:08:24 (3 years ago)
Author:
Ema <ema_spirova@…>
Branches:
master
Children:
8d391a1
Parents:
59329aa
Message:

primeNG components

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trip-planner-front/node_modules/wrap-ansi/readme.md

    r59329aa re29cc2e  
    1 # wrap-ansi [![Build Status](https://travis-ci.com/chalk/wrap-ansi.svg?branch=master)](https://travis-ci.com/chalk/wrap-ansi) [![Coverage Status](https://coveralls.io/repos/github/chalk/wrap-ansi/badge.svg?branch=master)](https://coveralls.io/github/chalk/wrap-ansi?branch=master)
     1# wrap-ansi [![Build Status](https://travis-ci.org/chalk/wrap-ansi.svg?branch=master)](https://travis-ci.org/chalk/wrap-ansi) [![Coverage Status](https://coveralls.io/repos/github/chalk/wrap-ansi/badge.svg?branch=master)](https://coveralls.io/github/chalk/wrap-ansi?branch=master)
    22
    33> Wordwrap a string with [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles)
     4
    45
    56## Install
    … …  
    89$ npm install wrap-ansi
    910```
     11
    1012
    1113## Usage
    … …  
    2325<img width="331" src="screenshot.png">
    2426
    25 ## API
    26 
    27 ### wrapAnsi(string, columns, options?)
    28 
    29 Wrap words to the specified column width.
    30 
    31 #### string
    32 
    33 Type: `string`
    34 
    35 String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/chalk/chalk). Newline characters will be normalized to `\n`.
    36 
    37 #### columns
    38 
    39 Type: `number`
    40 
    41 Number of columns to wrap the text to.
    42 
    43 #### options
    44 
    45 Type: `object`
    46 
    47 ##### hard
    48 
    49 Type: `boolean`\
    50 Default: `false`
    51 
    52 By default the wrap is soft, meaning long words may extend past the column width. Setting this to `true` will make it hard wrap at the column width.
    53 
    54 ##### wordWrap
    55 
    56 Type: `boolean`\
    57 Default: `true`
    58 
    59 By default, an attempt is made to split words at spaces, ensuring that they don't extend past the configured columns. If wordWrap is `false`, each column will instead be completely filled splitting words as necessary.
    60 
    61 ##### trim
    62 
    63 Type: `boolean`\
    64 Default: `true`
    65 
    66 Whitespace on all lines is removed by default. Set this option to `false` if you don't want to trim.
    67 
    68 ## Related
    69 
    70 - [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
    71 - [cli-truncate](https://github.com/sindresorhus/cli-truncate) - Truncate a string to a specific width in the terminal
    72 - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
    73 - [jsesc](https://github.com/mathiasbynens/jsesc) - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.
    74 
    75 ## Maintainers
    76 
    77 - [Sindre Sorhus](https://github.com/sindresorhus)
    78 - [Josh Junon](https://github.com/qix-)
    79 - [Benjamin Coe](https://github.com/bcoe)
    80 
    8127---
    8228
    … …  
    9036        </sub>
    9137</div>
     38
     39---
     40
     41
     42## API
     43
     44### wrapAnsi(input, columns, [options])
     45
     46Wrap words to the specified column width.
     47
     48#### input
     49
     50Type: `string`
     51
     52String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/chalk/chalk).
     53
     54#### columns
     55
     56Type: `number`
     57
     58Number of columns to wrap the text to.
     59
     60#### options
     61
     62Type: `Object`
     63
     64##### hard
     65
     66Type: `boolean`<br>
     67Default: `false`
     68
     69By default the wrap is soft, meaning long words may extend past the column width. Setting this to `true` will make it hard wrap at the column width.
     70
     71##### wordWrap
     72
     73Type: `boolean`<br>
     74Default: `true`
     75
     76By default, an attempt is made to split words at spaces, ensuring that they don't extend past the configured columns. If wordWrap is `false`, each column will instead be completely filled splitting words as necessary.
     77
     78##### trim
     79
     80Type: `boolean`<br>
     81Default: `true`
     82
     83Whitespace on all lines is removed by default. Set this option to `false` if you don't want to trim.
     84
     85
     86## Related
     87
     88- [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
     89- [cli-truncate](https://github.com/sindresorhus/cli-truncate) - Truncate a string to a specific width in the terminal
     90- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
     91- [jsesc](https://github.com/mathiasbynens/jsesc) - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.
     92
     93
     94## Maintainers
     95
     96- [Sindre Sorhus](https://github.com/sindresorhus)
     97- [Josh Junon](https://github.com/qix-)
     98- [Benjamin Coe](https://github.com/bcoe)
     99
     100
     101## Security
     102
     103To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
     104
     105
     106## License
     107
     108MIT
Note: See TracChangeset for help on using the changeset viewer.