Module "tools/writer"

Index

Type aliases

TransformOptionsExt

Functions

Type aliases

TransformOptionsExt

TransformOptionsExt: TransformOptions & { maxLine?: number; maxPrefix?: number }

Functions

createTransform

createTransform(prefix: string, filters: FilterChunk[], options?: TransformOptionsExt): Transform
createTransform(prefix: string, filter: FilterChunk, options?: TransformOptionsExt): Transform
createTransform(prefix: string, options?: TransformOptionsExt): Transform

- Defined in tools/writer.ts:35
Parameters
- prefix: string
- filters: FilterChunk[]
- Optional options: TransformOptionsExt
Returns Transform
- Defined in tools/writer.ts:37
Parameters
- prefix: string
- filter: FilterChunk
- Optional options: TransformOptionsExt
Returns Transform
- Defined in tools/writer.ts:39
Parameters
- prefix: string
- Optional options: TransformOptionsExt
Returns Transform

maxLength

maxLength(vals: string[]): number

- Defined in tools/writer.ts:13
Gets the max length of an array of string.

Parameters
- vals: string[]
  
  the values to calculate length for.
Returns number

padRight

padRight(str: string, max?: number): string

- Defined in tools/writer.ts:28
Pads string to right for alignment.

Parameters
- str: string
  
  the string to be padded.
- Default value max: number = 13
  
  the max string length of longest item.
Returns string

Generated using TypeDoc