ubdate
This commit is contained in:
80
node_modules/lpad-align/readme.md
generated
vendored
Normal file
80
node_modules/lpad-align/readme.md
generated
vendored
Normal file
@@ -0,0 +1,80 @@
|
||||
# lpad-align [](https://travis-ci.org/kevva/lpad-align)
|
||||
|
||||
> Left pad a string to align with the longest string in an array
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install --save lpad-align
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const lpadAlign = require('lpad-align');
|
||||
|
||||
const words = [
|
||||
'foo',
|
||||
'foobar',
|
||||
'foobarcat'
|
||||
];
|
||||
|
||||
for (const x of words) {
|
||||
console.log(lpadAlign(x, words, 4));
|
||||
}
|
||||
|
||||
/*
|
||||
foo
|
||||
foobar
|
||||
foobarcat
|
||||
*/
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### lpadAlign(string, array, pad)
|
||||
|
||||
#### string
|
||||
|
||||
Type: `string`
|
||||
|
||||
String that will be padded.
|
||||
|
||||
#### array
|
||||
|
||||
Type: `Array`
|
||||
|
||||
Array to align against.
|
||||
|
||||
#### pad
|
||||
|
||||
Type: `number`<br>
|
||||
Default: `4`
|
||||
|
||||
Indentation to prepend the string with.
|
||||
|
||||
|
||||
## CLI
|
||||
|
||||
```
|
||||
$ npm install --global lpad-align
|
||||
```
|
||||
|
||||
```
|
||||
Usage
|
||||
$ cat <file> | lpad-align
|
||||
|
||||
Example
|
||||
$ cat unicorn.txt | lpad-align
|
||||
foo
|
||||
foobar
|
||||
foobarcat
|
||||
```
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Kevin Mårtensson](https://github.com/kevva)
|
||||
Reference in New Issue
Block a user