Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Padding

A Format.Utils sub-module exposing the pad method for string padding operations.

Index

Variables

Private directionStrategies

directionStrategies: Indexable<function>

Functions

Private getPadWidth

  • getPadWidth(value: string, options: Options): number

Private getPadding

  • getPadding(padWidth: number, options: Options): string

Private isPaddingRequired

  • isPaddingRequired(value: string, options: Options): boolean

pad

  • pad(value: string, options: Options): string
  • Returns a new string of a specified length in which the beginning and/or ending of the current string is padded with spaces or with a specified character.

    Parameters

    • value: string

      The string to apply padding to.

    • options: Options

      An Options object that defines the desired output.

    Returns string

Private setDefaultOptions

  • setDefaultOptions(options: Options): void

Private validateOptions

  • validateOptions(options: Options): void

Generated using TypeDoc