Class FRMT

A robust, printf-style String formatter. (see: printf)

Hierarchy

FRMT

Callable

__call(nests: FMTemplate[], debug: boolean): FRMT

- Defined in dffrnt.utils/lib/utils.d.ts:1046
Creates an instance of FRMT.

Parameters
- nests: FMTemplate[]
  
  A collection of inner templates that the primary template will reference
- debug: boolean
  
  If true, output debug information to the console
Returns FRMT

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new FRMT(nests: FMTemplate[], debug: boolean): FRMT

- Defined in dffrnt.utils/lib/utils.d.ts:1054
Creates an instance of FRMT.

Parameters
- nests: FMTemplate[]
  
  A collection of inner templates that the primary template will reference
- debug: boolean
  
  If true, output debug information to the console
Returns FRMT

Accessors

Private MODS

get MODS(): FRMTMods

- Defined in dffrnt.utils/lib/utils.d.ts:1066
The format modifiers.

Returns FRMTMods

Private OPTNS

get OPTNS(): FRMTOpts

- Defined in dffrnt.utils/lib/utils.d.ts:1070
The format Options

Returns FRMTOpts

Private FNTS

get FNTS(): FRMTFonts

- Defined in dffrnt.utils/lib/utils.d.ts:1074
The format Font-styling.

Returns FRMTFonts

Private TYPS

get TYPS(): FRMTTypes

- Defined in dffrnt.utils/lib/utils.d.ts:1078
The format Types

Returns FRMTTypes

Private REG

get REG(): RGX

- Defined in dffrnt.utils/lib/utils.d.ts:1083
The RGX strategy.

Returns RGX

Private Nstr

get Nstr(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1088
...

Returns RegExp

Private Idxr

get Idxr(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1092
...

Returns RegExp

Private Each

get Each(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1096
...

Returns RegExp

Private Pair

get Pair(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1100
...

Returns RegExp

Private List

get List(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1104
...

Returns RegExp

Private Norm

get Norm(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1108
...

Returns RegExp

Private Keys

get Keys(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1112
...

Returns RegExp

Private PItr

get PItr(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1116
...

Returns RegExp

Private Opts

get Opts(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1120
...

Returns RegExp

Private OptO

get OptO(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1124
...

Returns RegExp

Private Pads

get Pads(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1128
...

Returns RegExp

Private Typs

get Typs(): RegExp

- Defined in dffrnt.utils/lib/utils.d.ts:1132
...

Returns RegExp

Private IDX

get IDX(): any

- Defined in dffrnt.utils/lib/utils.d.ts:1142
...

Returns any

Private PADS

get PADS(): any

- Defined in dffrnt.utils/lib/utils.d.ts:1146
...

Returns any

Private FLTR

get FLTR(): any

- Defined in dffrnt.utils/lib/utils.d.ts:1150
...

Returns any

Find

get Find(): object

- Defined in dffrnt.utils/lib/utils.d.ts:1155
...

Returns object
- Obj: function
  - Obj(cnts: FMCounts, grps: FMGroups, strict: boolean, _typ: FMType): DCT | Imm.Map
  - - Defined in dffrnt.utils/lib/utils.d.ts:1164
    Finds the next Object literal to insert into the template
    
    Parameters
    - cnts: FMCounts
      
      The FMCounts object
    - grps: FMGroups
      
      The FMGroups object
    - strict: boolean
      
      The FMStrict flag
    - _typ: FMType
      
      The FMtype flag
    Returns DCT | Imm.Map
    
    The next Object literal
- Lst: function
  - Lst(cnts: FMCounts, grps: FMGroups, strict: boolean, _typ: FMType): any
  - - Defined in dffrnt.utils/lib/utils.d.ts:1173
    Finds the next Array list to insert into the template
    
    Parameters
    - cnts: FMCounts
      
      The FMCounts object
    - grps: FMGroups
      
      The FMGroups object
    - strict: boolean
      
      The FMStrict flag
    - _typ: FMType
      
      The FMtype flag
    Returns any
    
    The next Array list
- Nrm: function
  - Nrm(mch: string | number, cnts: FMCounts, grps: FMGroups, strict: boolean, typ: FMType): string
  - - Defined in dffrnt.utils/lib/utils.d.ts:1184
    Finds & formats the next String|Number to insert into the template. This is the end of all template variables.
    
    Parameters
    - mch: string | number
      
      A value to replace or format; if applicable
    - cnts: FMCounts
      
      The FMCounts object
    - grps: FMGroups
      
      The FMGroups object
    - strict: boolean
      
      The FMStrict flag
    - typ: FMType
      
      The FMtype flag
    Returns string
    
    The formatted String
- Key: function
  - Key(txt: string, mch: string | number, grps: FMGroups, strict: boolean, _typ: FMType): FMKeyVal
  - - Defined in dffrnt.utils/lib/utils.d.ts:1194
    Finds the next set of named variable to insert into the template
    
    Parameters
    - txt: string
      
      The name variable String
    - mch: string | number
      
      The full name template variable
    - grps: FMGroups
      
      The FMGroups object for named variables
    - strict: boolean
      
      The FMStrict flag
    - _typ: FMType
      
      The FMtype flag
    Returns FMKeyVal
    
    The formatted String

Methods

LOGS

LOGS(): void

- Defined in dffrnt.utils/lib/utils.d.ts:1137
...

Returns void

Private Options

Options(opts: FRMTStruct): FRMTStruct

- Defined in dffrnt.utils/lib/utils.d.ts:1201
Registers valid format options.

Parameters
- opts: FRMTStruct
  
  The format options.
Returns FRMTStruct

Private Types

Types(typs: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1207
Parameters
- typs: any
Returns string

Private Paddings

Paddings(pads: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1212
Parameters
- pads: any
Returns string

Private Replace

Replace(text: any, opt: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1218
Parameters
- text: any
- opt: any
Returns string

Private Empty

Empty(val: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1223
Parameters
- val: any
Returns string

Private Case

Case(text: any, cases: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1229
Parameters
- text: any
- cases: any
Returns string

Private Font

Font(text: any, font: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1235
Parameters
- text: any
- font: any
Returns string

Private Close

Close(text: any, pfx: any, sfx: any, key: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1243
Parameters
- text: any
- pfx: any
- sfx: any
- key: any
Returns string

Private KVs

KVs(ArgS: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1248
Parameters
- ArgS: any
Returns string

Private Nest

Nest(key: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1253
Parameters
- key: any
Returns string

Private Delimit

Delimit(res: any, opts: any, pads: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1260
Parameters
- res: any
- opts: any
- pads: any
Returns string

Private Finalize

Finalize(text: any, opts: any, pad: any, key: any): string

- Defined in dffrnt.utils/lib/utils.d.ts:1268
Parameters
- text: any
- opts: any
- pad: any
- key: any
Returns string

_

_(template: FMTemplate, ...VARS: any[]): string

- Defined in dffrnt.utils/lib/utils.d.ts:1276
Formats a String with a printf-style template and given arguments.

Parameters
- template: FMTemplate
  
  A printf-style template ()
- Rest ...VARS: any[]
  
  The values to inster into the template. The last argument can be an Object.<string,any> for named variable.
Returns string

The formatted String

ie

ie(): void

- Defined in dffrnt.utils/lib/utils.d.ts:1281
Prints an example.

Returns void