# paddys

> Pad Strings To Equalise The Length Of Each Line.

Latest version **1.2.0** (published 2019-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install paddys
pnpm add paddys
yarn add paddys
bun add paddys
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2019-04-25 |
| First published | 2018-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Anton |
| Maintainers | zvr |
| Keywords | paddys, pad, strings, string, length, width, equal, equalise |

## Links

- npm: https://www.npmjs.com/package/paddys
- Repository: https://github.com/artdecocode/paddys
- Homepage: https://github.com/artdecocode/paddys#readme
- Issues: https://github.com/artdecocode/paddys/issues
- npm.io page: https://npm.io/package/paddys

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2019-04-25
- 1.1.0 — 2019-04-02
- 1.0.1 — 2018-10-15
- 1.0.0 — 2018-10-15

## README

# paddys

[![npm version](https://badge.fury.io/js/paddys.svg)](https://npmjs.org/package/paddys)

`paddys` is a package that pads strings so that each line is of the width of the longest line. It can also pad to a specific length.

```sh
yarn add -E paddys
```

## Table Of Contents

- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`paddys(string: string, options?: Config): string`](#paddysstring-stringoptions-config-string)
  * [`_paddys.Config`](#type-_paddysconfig)
- [Copyright](#copyright)

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/0.svg?sanitize=true"></a></p>

## API

The package is available by importing its default function:

```js
import paddys from 'paddys'
```

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/1.svg?sanitize=true"></a></p>

## `paddys(`<br/>&nbsp;&nbsp;`string: string,`<br/>&nbsp;&nbsp;`options?: Config,`<br/>`): string`

Pads the string to the right to equalise the length of each line.

__<a name="type-_paddysconfig">`_paddys.Config`</a>__: Options for the program.

| Name  |      Type       |           Description            |
| ----- | --------------- | -------------------------------- |
| width | <em>number</em> | The width to which to pad lines. |

```js
/* yarn example/ */
import paddys from 'paddys'

const res = paddys(
  `Just stop your wandering,
Look penetratingly into your inherent nature,
And, concentrating your spiritual energy,
Sit in zazen
And break through.`
)
```
```
Just stop your wandering,____________________
Look penetratingly into your inherent nature,
And, concentrating your spiritual energy,____
Sit in zazen_________________________________
And break through.___________________________
```

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/2.svg?sanitize=true"></a></p>

## Copyright

<table>
  <tr>
    <th>
      <a href="https://artd.eco">
        <img src="https://raw.githubusercontent.com/wrote/wrote/master/images/artdeco.png" alt="Art Deco" />
      </a>
    </th>
    <th>© <a href="https://artd.eco">Art Deco</a>   2019</th>
    <th>
      <a href="https://www.technation.sucks" title="Tech Nation Visa">
        <img src="https://raw.githubusercontent.com/artdecoweb/www.technation.sucks/master/anim.gif"
          alt="Tech Nation Visa" />
      </a>
    </th>
    <th><a href="https://www.technation.sucks">Tech Nation Visa Sucks</a></th>
  </tr>
</table>

<p align="center"><a href="#table-of-contents"><img src=".documentary/section-breaks/-1.svg?sanitize=true"></a></p>

---
_Source: https://npm.io/package/paddys · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._