# pad-md

> A NodeJS module for string padding.

Latest version **0.0.6** (published 2018-10-05) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install pad-md
pnpm add pad-md
yarn add pad-md
bun add pad-md
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2018-10-05 |
| First published | 2017-07-22 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 41.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marton Demeter |
| Maintainers | mdemeter |
| Keywords | pad, padding |

## Links

- npm: https://www.npmjs.com/package/pad-md
- Repository: https://github.com/marton-demeter/pad-md
- Homepage: https://github.com/marton-demeter/pad-md#readme
- Issues: https://github.com/marton-demeter/pad-md/issues
- npm.io page: https://npm.io/package/pad-md

## Recent versions

- 0.0.6 (latest) — 2018-10-05
- 0.0.5 — 2017-12-11
- 0.0.4 — 2017-11-01
- 0.0.3 — 2017-11-01
- 0.0.2 — 2017-07-22
- 0.0.1 — 2017-07-22

## README

# Description

This is a module for simple string padding. It only returns the modified string, it doesn't write to stdout.

# Installation

##### Local

```
  [sudo] npm install --save pad-md
```

##### Global

```
  [sudo] npm install --global pad-md
```

# Usage

```javascript
  const pad = require('pad-md');
  
  var result = pad.left('text', 5);       // " text"
  var result = pad.right('text', 5);      // "text "
  
  // provide fill
  var result = pad.left('text', 5, '+');  // "+text"
  var result = pad.right('text', 5, '_'); // "text_"
  
  // set default (persistent) left fill
  pad.tl('+');
  
  // set default (persistent) right fill
  pad.tr('_');
  
  var result = pad.left('text', 5)  // "+text"
  var result = pad.right('text', 5) // "text_"
  
  // reset left and right fill
  pad.reset();
  
  var result = pad.left('text', 5)  // " text"
  var result = pad.right('text', 5) // "text "
  
  // set default (persistent) left and right fill
  var result = pad.fill('+');
  
  var result = pad.mid('text', 5)    // "+++text+++"
  var result = pad.mid('text', 5, 3) // "+++text+"
  
  var result = pad.reset();
  
  // set the edge fill
  var result = pad.mid('text', 5, 5, '#'); // "#  text  #"
  var result = pad.mid('text', 3, 5, '#'); // "#text  #"
  
  // intuitive padding - right
  var result = pad.pad('text', 5); // "text "
  
  // intuitive padding - left
  var result = pad.pad(5, 'text'); // " text"
  
  var result = pad.pad('text', 5, '_'); // "text_"
  var result = pad.pad(5, 'text', '+'); // "+text"
  
  // log result
  console.log(result);
  
```

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