Interface PadOptions

Options for pad functions.

interface PadOptions {
    color?: StringTransformer;
    padder?: string;
    sizer?: Sizer;
    string: string;
    width: number;
}

Hierarchy (view full)

PadOptions
- PadWithSideOptions

Index

Properties

color? padder? sizer? string width

Properties

`Optional` color

color?: StringTransformer

A custom function for adding color codes (or any non-rendered element) to the padding.

`Optional` padder

padder?: string

The string to use as a padder.

`Optional` sizer

sizer?: Sizer

A custom function for determing the size of the provided string.

string

string: string

The string to pad.

width

width: number

The desired width of the string.