-
Notifications
You must be signed in to change notification settings - Fork 16
/
StringTransformEvaluator.yml
134 lines (134 loc) · 4.8 KB
/
StringTransformEvaluator.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
### YamlMime:TSType
name: StringTransformEvaluator
uid: adaptive-expressions.StringTransformEvaluator
package: adaptive-expressions
summary: Evaluator that transforms a string to another string.
fullName: StringTransformEvaluator
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: >-
StringTransformEvaluator(string, (arg0: any[], options: Options) =>
string, (expr: Expression) => void)
uid: adaptive-expressions.StringTransformEvaluator.constructor
package: adaptive-expressions
summary: >-
Initializes a new instance of the
[StringTransformEvaluator](xref:adaptive-expressions.StringTransformEvaluator)
class.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new StringTransformEvaluator(type: string, func: (arg0: any[], options:
Options) => string, validator?: (expr: Expression) => void)
parameters:
- id: type
type: string
description: Name of the built-in function.
- id: func
type: '(arg0: any[], options: Options) => string'
description: >-
The string transformation function, it takes a list of objects and
returns an string.
- id: validator
type: '(expr: Expression) => void'
description: |
The validation function.
properties:
- name: negation
uid: adaptive-expressions.StringTransformEvaluator.negation
package: adaptive-expressions
summary: |-
Gets the evaluator that is a negation of this one.
Sets the evaluator that is a negation of this one.
fullName: negation
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: ExpressionEvaluator negation
return:
description: The evaluator that is a negation of this one.
type: <xref uid="adaptive-expressions.ExpressionEvaluator" />
inheritedProperties:
- name: returnType
uid: adaptive-expressions.StringTransformEvaluator.returnType
package: adaptive-expressions
summary: Type expected by evaluating the expression.
fullName: returnType
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'returnType: ReturnType'
return:
description: ''
type: <xref uid="adaptive-expressions.ReturnType" />
inheritanceDescription: >-
<b>Inherited From</b>
[ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType)
- name: type
uid: adaptive-expressions.StringTransformEvaluator.type
package: adaptive-expressions
summary: Gets the expression type for evaluator.
fullName: type
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'type: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type)
inheritedMethods:
- name: 'tryEvaluate(Expression, MemoryInterface, Options)'
uid: adaptive-expressions.StringTransformEvaluator.tryEvaluate
package: adaptive-expressions
summary: Evaluate an expression.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function tryEvaluate(expression: Expression, state: MemoryInterface,
options: Options): ValueWithError
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression to evaluate.
- id: state
type: <xref uid="adaptive-expressions.MemoryInterface" />
description: Global state information.
- id: options
type: <xref uid="adaptive-expressions.Options" />
description: Options used in the evaluation.
return:
description: The value and error string that is non-null if there is an error.
type: <xref uid="adaptive-expressions.ValueWithError" />
inheritanceDescription: >-
<b>Inherited From</b>
[ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate)
- name: validateExpression(Expression)
uid: adaptive-expressions.StringTransformEvaluator.validateExpression
package: adaptive-expressions
summary: Validate an expression.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function validateExpression(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression to validate.
inheritanceDescription: >-
<b>Inherited From</b>
[ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression)
extends: <xref uid="adaptive-expressions.ExpressionEvaluator" />