-
Notifications
You must be signed in to change notification settings - Fork 16
/
FunctionUtils.yml
876 lines (875 loc) · 30.9 KB
/
FunctionUtils.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
### YamlMime:TSType
name: FunctionUtils
uid: adaptive-expressions.FunctionUtils
package: adaptive-expressions
summary: Utility functions in AdaptiveExpression.
fullName: FunctionUtils
remarks: ''
isPreview: false
isDeprecated: false
type: class
properties:
- name: DefaultDateTimeFormat
uid: adaptive-expressions.FunctionUtils.DefaultDateTimeFormat
package: adaptive-expressions
summary: The default date time format string.
fullName: DefaultDateTimeFormat
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static DefaultDateTimeFormat: string = "YYYY-MM-DDTHH:mm:ss.SSS[Z]"'
return:
description: ''
type: string
methods:
- name: 'apply((arg0: unknown[]) => unknown, VerifyExpression)'
uid: adaptive-expressions.FunctionUtils.apply
package: adaptive-expressions
summary: >-
Generate an expression delegate that applies function after verifying all
children.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function apply(func: (arg0: unknown[]) => unknown, verify?:
VerifyExpression): EvaluateExpressionDelegate
parameters:
- id: func
type: '(arg0: unknown[]) => unknown'
description: Function to apply.
- id: verify
type: <xref uid="adaptive-expressions.VerifyExpression" />
description: Function to check each arg for validity.
return:
description: Delegate for evaluating an expression.
type: <xref uid="adaptive-expressions.EvaluateExpressionDelegate" />
- name: 'applySequence((arg0: any[]) => any, VerifyExpression)'
uid: adaptive-expressions.FunctionUtils.applySequence
package: adaptive-expressions
summary: >-
Generate an expression delegate that applies function on the accumulated
value after verifying all children.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function applySequence(func: (arg0: any[]) => any, verify?:
VerifyExpression): EvaluateExpressionDelegate
parameters:
- id: func
type: '(arg0: any[]) => any'
description: Function to apply.
- id: verify
type: <xref uid="adaptive-expressions.VerifyExpression" />
description: Function to check each arg for validity.
return:
description: Delegate for evaluating an expression.
type: <xref uid="adaptive-expressions.EvaluateExpressionDelegate" />
- name: 'applySequenceWithError((arg0: any[]) => any, VerifyExpression)'
uid: adaptive-expressions.FunctionUtils.applySequenceWithError
package: adaptive-expressions
summary: >-
Generate an expression delegate that applies function on the accumulated
value after verifying all children.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function applySequenceWithError(func: (arg0: any[]) => any,
verify?: VerifyExpression): EvaluateExpressionDelegate
parameters:
- id: func
type: '(arg0: any[]) => any'
description: Function to apply.
- id: verify
type: <xref uid="adaptive-expressions.VerifyExpression" />
description: Function to check each arg for validity.
return:
description: Delegate for evaluating an expression.
type: <xref uid="adaptive-expressions.EvaluateExpressionDelegate" />
- name: 'applyWithError((arg0: any[]) => ValueWithError, VerifyExpression)'
uid: adaptive-expressions.FunctionUtils.applyWithError
package: adaptive-expressions
summary: >-
Generate an expression delegate that applies function after verifying all
children.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function applyWithError(func: (arg0: any[]) => ValueWithError,
verify?: VerifyExpression): EvaluateExpressionDelegate
parameters:
- id: func
type: '(arg0: any[]) => ValueWithError'
description: Function to apply.
- id: verify
type: <xref uid="adaptive-expressions.VerifyExpression" />
description: Function to check each arg for validity.
return:
description: Delegate for evaluating an expression.
type: <xref uid="adaptive-expressions.EvaluateExpressionDelegate" />
- name: >-
applyWithOptions((arg0: unknown[], options: Options) => unknown,
VerifyExpression)
uid: adaptive-expressions.FunctionUtils.applyWithOptions
package: adaptive-expressions
summary: >-
Generate an expression delegate that applies function after verifying all
children.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function applyWithOptions(func: (arg0: unknown[], options:
Options) => unknown, verify?: VerifyExpression):
EvaluateExpressionDelegate
parameters:
- id: func
type: '(arg0: unknown[], options: Options) => unknown'
description: Function to apply.
- id: verify
type: <xref uid="adaptive-expressions.VerifyExpression" />
description: Function to check each arg for validity.
return:
description: Delegate for evaluating an expression.
type: <xref uid="adaptive-expressions.EvaluateExpressionDelegate" />
- name: >-
applyWithOptionsAndError((arg0: unknown[], options: Options) => { error:
string, value: unknown }, VerifyExpression)
uid: adaptive-expressions.FunctionUtils.applyWithOptionsAndError
package: adaptive-expressions
summary: >-
Generate an expression delegate that applies function after verifying all
children.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function applyWithOptionsAndError(func: (arg0: unknown[],
options: Options) => { error: string, value: unknown }, verify?:
VerifyExpression): EvaluateExpressionDelegate
parameters:
- id: func
type: >-
(arg0: unknown[], options: Options) => { error: string, value:
unknown }
description: Function to apply.
- id: verify
type: <xref uid="adaptive-expressions.VerifyExpression" />
description: Function to check each arg for validity.
return:
description: Delegate for evaluating an expression.
type: <xref uid="adaptive-expressions.EvaluateExpressionDelegate" />
- name: 'commonEquals(unknown, unknown)'
uid: adaptive-expressions.FunctionUtils.commonEquals
package: adaptive-expressions
summary: |-
Equal helper function.
Compare the first param and second param.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function commonEquals(obj1: unknown, obj2: unknown): boolean'
parameters:
- id: obj1
type: unknown
description: The first value to compare.
- id: obj2
type: unknown
description: The second value to compare.
return:
description: A boolean based on the comparison.
type: boolean
- name: 'determineFormatAndLocale(unknown[], number, string, string)'
uid: adaptive-expressions.FunctionUtils.determineFormatAndLocale
package: adaptive-expressions
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function determineFormatAndLocale(args: unknown[], maxArgsLength:
number, format: string, locale: string): { format: string, locale:
string }
parameters:
- id: args
type: 'unknown[]'
description: An array of arguments.
- id: maxArgsLength
type: number
description: The max length of a given function.
- id: format
type: string
description: A format string.
- id: locale
type: string
description: A locale string.
return:
description: >-
The format and the locale from the args param, otherwise the locale
and format strings.
type: '{ format: string, locale: string }'
- name: 'determineLocale(unknown[], number, string)'
uid: adaptive-expressions.FunctionUtils.determineLocale
package: adaptive-expressions
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function determineLocale(args: unknown[], maxArgsLength: number,
locale: string): string
parameters:
- id: args
type: 'unknown[]'
description: An array of arguments.
- id: maxArgsLength
type: number
description: The max length of a given function.
- id: locale
type: string
description: A locale string
return:
description: 'The last item from the args param, otherwise the locale string.'
type: string
- name: 'evaluateChildren(Expression, MemoryInterface, Options, VerifyExpression)'
uid: adaptive-expressions.FunctionUtils.evaluateChildren
package: adaptive-expressions
summary: Evaluate expression children and return them.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function evaluateChildren(expression: Expression, state:
MemoryInterface, options: Options, verify?: VerifyExpression): { args:
any[], error: string }
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression with children.
- id: state
type: <xref uid="adaptive-expressions.MemoryInterface" />
description: Global state.
- id: options
type: <xref uid="adaptive-expressions.Options" />
description: Options used in evaluation.
- id: verify
type: <xref uid="adaptive-expressions.VerifyExpression" />
description: Optional function to verify each child's result.
return:
description: List of child values or error message.
type: '{ args: any[], error: string }'
- name: isNumber(any)
uid: adaptive-expressions.FunctionUtils.isNumber
package: adaptive-expressions
summary: Is number helper function.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function isNumber(instance: any): boolean'
parameters:
- id: instance
type: any
description: Input.
return:
description: True if the input is a number.
type: boolean
- name: timestampFormatter(string)
uid: adaptive-expressions.FunctionUtils.timestampFormatter
package: adaptive-expressions
summary: 'Timestamp formatter, convert C# datetime to day.js format.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function timestampFormatter(formatter: string): string'
parameters:
- id: formatter
type: string
description: C# datetime format
return:
description: The formated datetime.
type: string
- name: 'tryAccumulatePath(Expression, MemoryInterface, Options)'
uid: adaptive-expressions.FunctionUtils.tryAccumulatePath
package: adaptive-expressions
summary: State object for resolving memory paths.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function tryAccumulatePath(expression: Expression, state:
MemoryInterface, options: Options): { error: string, left: any, path:
string }
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression.
- id: state
type: <xref uid="adaptive-expressions.MemoryInterface" />
description: Scope.
- id: options
type: <xref uid="adaptive-expressions.Options" />
description: Options used in evaluation.
return:
description: >-
Return the accumulated path and the expression left unable to
accumulate.
type: '{ error: string, left: any, path: string }'
- name: 'validateArityAndAnyType(Expression, number, number, ReturnType)'
uid: adaptive-expressions.FunctionUtils.validateArityAndAnyType
package: adaptive-expressions
summary: >-
Validate that expression has a certain number of children that are of any
of the supported types.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function validateArityAndAnyType(expression: Expression,
minArity: number, maxArity: number, returnType: ReturnType)
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression to validate.
- id: minArity
type: number
description: Minimum number of children.
- id: maxArity
type: number
description: Maximum number of children.
- id: returnType
type: <xref uid="adaptive-expressions.ReturnType" />
description: >
Allowed return types for children.
If a child has a return type of Object then validation will happen
at runtime.
- name: validateAtLeastOne(Expression)
uid: adaptive-expressions.FunctionUtils.validateAtLeastOne
package: adaptive-expressions
summary: Validate at least 1 argument of any type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateAtLeastOne(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateBinary(Expression)
uid: adaptive-expressions.FunctionUtils.validateBinary
package: adaptive-expressions
summary: Validate there are two children.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateBinary(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateBinaryNumber(Expression)
uid: adaptive-expressions.FunctionUtils.validateBinaryNumber
package: adaptive-expressions
summary: Validate 2 numeric arguments.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateBinaryNumber(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateBinaryNumberOrString(Expression)
uid: adaptive-expressions.FunctionUtils.validateBinaryNumberOrString
package: adaptive-expressions
summary: Validate there are 2 numeric or string arguments.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateBinaryNumberOrString(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateNumber(Expression)
uid: adaptive-expressions.FunctionUtils.validateNumber
package: adaptive-expressions
summary: Validate 1 or more numeric arguments.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateNumber(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: 'validateOrder(Expression, ReturnType[], ReturnType[])'
uid: adaptive-expressions.FunctionUtils.validateOrder
package: adaptive-expressions
summary: Validate the number and type of arguments to a function.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function validateOrder(expression: Expression, optional:
ReturnType[], types: ReturnType[])
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression to validate.
- id: optional
type: '<xref uid="adaptive-expressions.ReturnType" />[]'
description: Optional types in order.
- id: types
type: '<xref uid="adaptive-expressions.ReturnType" />[]'
description: |
Expected types in order.
- name: validateString(Expression)
uid: adaptive-expressions.FunctionUtils.validateString
package: adaptive-expressions
summary: Validate 1 or more string arguments.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateString(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateTwoOrMoreThanTwoNumbers(Expression)
uid: adaptive-expressions.FunctionUtils.validateTwoOrMoreThanTwoNumbers
package: adaptive-expressions
summary: Validate 2 or more than 2 numeric arguments.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateTwoOrMoreThanTwoNumbers(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateUnary(Expression)
uid: adaptive-expressions.FunctionUtils.validateUnary
package: adaptive-expressions
summary: Validate there is a single argument.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateUnary(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateUnaryBoolean(Expression)
uid: adaptive-expressions.FunctionUtils.validateUnaryBoolean
package: adaptive-expressions
summary: Validate there is a single boolean argument.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateUnaryBoolean(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateUnaryNumber(Expression)
uid: adaptive-expressions.FunctionUtils.validateUnaryNumber
package: adaptive-expressions
summary: Validate there is a single argument.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateUnaryNumber(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateUnaryOrBinaryNumber(Expression)
uid: adaptive-expressions.FunctionUtils.validateUnaryOrBinaryNumber
package: adaptive-expressions
summary: Validate 1 or 2 numeric arguments.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateUnaryOrBinaryNumber(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateUnaryOrBinaryString(Expression)
uid: adaptive-expressions.FunctionUtils.validateUnaryOrBinaryString
package: adaptive-expressions
summary: Validate there is one or two string arguments.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateUnaryOrBinaryString(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: validateUnaryString(Expression)
uid: adaptive-expressions.FunctionUtils.validateUnaryString
package: adaptive-expressions
summary: Validate there is a single string argument.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function validateUnaryString(expression: Expression)'
parameters:
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: |
Expression to validate.
- name: 'verifyBoolean(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyBoolean
package: adaptive-expressions
summary: Verify value is boolean.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyBoolean(value: any, expression: Expression, _:
number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyContainer(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyContainer
package: adaptive-expressions
summary: Verify value contains elements.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyContainer(value: any, expression: Expression, _:
number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyContainerOrNull(unknown, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyContainerOrNull
package: adaptive-expressions
summary: Verify value contains elements or null.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyContainerOrNull(value: unknown, expression:
Expression, _: number): string | undefined
parameters:
- id: value
type: unknown
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyInteger(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyInteger
package: adaptive-expressions
summary: Verify value is an integer.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyInteger(value: any, expression: Expression, _:
number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyList(any, Expression)'
uid: adaptive-expressions.FunctionUtils.verifyList
package: adaptive-expressions
summary: Verify value is an list.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyList(value: any, expression: Expression): string |
undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyNotNull(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyNotNull
package: adaptive-expressions
summary: Verify value is not null or undefined.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyNotNull(value: any, expression: Expression, _:
number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if valid.
type: string | undefined
- name: 'verifyNumber(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyNumber
package: adaptive-expressions
summary: Verify value is numeric.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyNumber(value: any, expression: Expression, _:
number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyNumberOrNumericList(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyNumberOrNumericList
package: adaptive-expressions
summary: Verify value is numeric.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyNumberOrNumericList(value: any, expression:
Expression, _: number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyNumberOrString(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyNumberOrString
package: adaptive-expressions
summary: Verify value is a number or string.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyNumberOrString(value: any, expression: Expression,
_: number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyNumberOrStringOrNull(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyNumberOrStringOrNull
package: adaptive-expressions
summary: Verify value is a number or string or null.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyNumberOrStringOrNull(value: any, expression:
Expression, _: number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyNumericList(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyNumericList
package: adaptive-expressions
summary: Verify value is numeric list.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyNumericList(value: any, expression: Expression, _:
number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyString(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyString
package: adaptive-expressions
summary: Verify value is a string.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyString(value: any, expression: Expression, _:
number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined
- name: 'verifyStringOrNull(any, Expression, number)'
uid: adaptive-expressions.FunctionUtils.verifyStringOrNull
package: adaptive-expressions
summary: Verify an object is neither a string nor null.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
static function verifyStringOrNull(value: any, expression: Expression,
_: number): string | undefined
parameters:
- id: value
type: any
description: Value to check.
- id: expression
type: <xref uid="adaptive-expressions.Expression" />
description: Expression that led to value.
- id: _
type: number
description: No function.
return:
description: Error or undefined if invalid.
type: string | undefined