Class Formatter

Hierarchy

Formatter

Index

Constructors

Properties

patterns separator unitFormat

Methods

format setFormat setPatterns setSeparator

Constructors

constructor

new Formatter(__namedParameters?: formatterOptions): Formatter
Parameters
- __namedParameters: formatterOptions = {}
Returns Formatter
- Defined in prettyFormat.ts:120

Properties

patterns

patterns: readonly ("day" | "hour" | "minute" | "month" | "second" | "year" | "week" | "y" | "mo" | "w" | "d" | "h" | "min" | "m" | "s" | "millisecond" | "milli" | "ms")[]

separator

separator: string

unitFormat

unitFormat: "long" | "short"

Methods

format

format(ms: number): undefined | string
Parameters
- ms: number
Returns undefined | string
- Defined in prettyFormat.ts:141

setFormat

setFormat(format: "long" | "short"): Formatter
Parameters
- format: "long" | "short"
Returns Formatter
- Defined in prettyFormat.ts:126

setPatterns

setPatterns(patterns: readonly ("day" | "hour" | "minute" | "month" | "second" | "year" | "week" | "y" | "mo" | "w" | "d" | "h" | "min" | "m" | "s" | "millisecond" | "milli" | "ms")[]): Formatter
Parameters
- patterns: readonly ("day" | "hour" | "minute" | "month" | "second" | "year" | "week" | "y" | "mo" | "w" | "d" | "h" | "min" | "m" | "s" | "millisecond" | "milli" | "ms")[]
Returns Formatter
- Defined in prettyFormat.ts:136

setSeparator

setSeparator(separator: string): Formatter
Parameters
- separator: string
Returns Formatter
- Defined in prettyFormat.ts:131

Generated using TypeDoc