Home Manual Reference Source Test Repository
public class | source

SafeEntry

Defines the parameters for a safe string object lookup. If the accessor resolves against a given object then a string is created by combining the prepend / append strings between the value with optional new lines appended at the end. If a template tag function is defined it is applied to the template string.

Constructor Summary

Public Constructor
public

constructor(prependString: string, accessor: string, newLine: number, appendString: string, tagFunction: function)

Initializes SafeEntry instance.

Member Summary

Public Members
public get

Returns the accessor string describing the lookup operation.

public get

Returns a string to append to the end if any.

public get

Returns the new line count.

public get

Returns the string to prepend.

public get

Returns a template tag function to apply if any.

Private Members
private

The accessor string describing the lookup operation.

private

A string to append to the end.

private

The number of newlines characters to append.

private

The string to prepend.

private

A template tag function to apply.

Public Constructors

public constructor(prependString: string, accessor: string, newLine: number, appendString: string, tagFunction: function) source

Initializes SafeEntry instance.

Params:

NameTypeAttributeDescription
prependString string

The string to prepend.

accessor string

The accessor string describing the lookup operation.

newLine number

(Optional) The number of newlines characters to append.

appendString string

(Optional) A string to append to the end.

tagFunction function

(Optional) A template tag function to apply.

Public Members

public get accessor: string: * source

Returns the accessor string describing the lookup operation.

Return:

string

public get appendString: string: * source

Returns a string to append to the end if any.

Return:

string

public get newLine: number: * source

Returns the new line count.

Return:

number

public get prependString: string: * source

Returns the string to prepend.

Return:

string

public get tagFunction: Function: * source

Returns a template tag function to apply if any.

Return:

Function

Private Members

private _accessor: string source

The accessor string describing the lookup operation.

private _appendString: string source

A string to append to the end.

private _newLine: number source

The number of newlines characters to append.

private _prependString: string source

The string to prepend.

private _tagFunction: Function source

A template tag function to apply.