Class: FilterContext
Defined in: src/filter.ts:32
Render-time filter invocation context.
Constructors
Constructor
new FilterContext(
context,span,options):FilterContext
Defined in: src/filter.ts:33
Parameters
context
span
options
Record<string, unknown>
Returns
FilterContext
Properties
context
readonlycontext:RenderContext
Defined in: src/filter.ts:34
options
readonlyoptions:Record<string,unknown>
Defined in: src/filter.ts:36
span
readonlyspan:Token
Defined in: src/filter.ts:35
Methods
assertArgs()
assertArgs(
len,min,max?):void
Defined in: src/filter.ts:43
Assert that len is between min and max. Raise an ArgumentError if
it is not. len should include the left in its count.
Parameters
len
number
min
number
max?
number = min
Returns
void
getItem()
getItem(
obj,key,default_?):unknown
Defined in: src/filter.ts:54
Parameters
obj
unknown
key
unknown
default_?
unknown
Returns
unknown
inputArray()
inputArray(
obj):unknown[]
Defined in: src/filter.ts:99
Coerce obj to an array suitable for filters that expect an array input.
Parameters
obj
unknown
Returns
unknown[]
isNil()
isNil(
obj):boolean
Defined in: src/filter.ts:110
Parameters
obj
unknown
Returns
boolean
isTruthy()
isTruthy(
obj):boolean
Defined in: src/filter.ts:119
Parameters
obj
unknown
Returns
boolean
toInteger()
toInteger(
obj):number
Defined in: src/filter.ts:123
Parameters
obj
unknown
Returns
number
toLiquidNumber()
toLiquidNumber<
T>(obj,default_):LiquidNumber|T
Defined in: src/filter.ts:127
Type Parameters
T
T
Parameters
obj
unknown
default_
T
Returns
LiquidNumber | T
toString()
toString<
T>(obj,default_):string|T
Defined in: src/filter.ts:131
Type Parameters
T
T
Parameters
obj
unknown
default_
T
Returns
string | T
toStringSafe()
toStringSafe<
T>(obj,default_):string|HTMLSafeString|T
Defined in: src/filter.ts:137
Type Parameters
T
T
Parameters
obj
unknown
default_
T
Returns
string | HTMLSafeString | T