/
pow.ts
66 lines (64 loc) · 1.73 KB
/
pow.ts
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
import { FieldType } from '@terascope/types';
import {
FieldTransformConfig,
ProcessMode,
FunctionDefinitionType,
FunctionDefinitionCategory,
} from '../interfaces';
import { runMathFn } from './utils';
export interface PowerArgs {
readonly value: number;
}
export const powConfig: FieldTransformConfig<PowerArgs> = {
name: 'pow',
aliases: ['power'],
type: FunctionDefinitionType.FIELD_TRANSFORM,
process_mode: ProcessMode.INDIVIDUAL_VALUES,
category: FunctionDefinitionCategory.NUMERIC,
description: 'Returns a number representing the input value taken to the power of the value',
examples: [
{
args: { value: 3 },
config: {
version: 1,
fields: { testField: { type: FieldType.Byte } }
},
field: 'testField',
input: 7,
output: 343
},
{
args: { value: 0.5 },
config: {
version: 1,
fields: { testField: { type: FieldType.Byte } }
},
field: 'testField',
input: 4,
output: 2
}
],
create({ args: { value } }) {
// eslint-disable-next-line no-restricted-properties
return runMathFn(Math.pow, value);
},
accepts: [
FieldType.Number,
],
argument_schema: {
value: {
type: FieldType.Number,
array: false,
description: 'The exponent used to raise the base'
},
},
required_arguments: ['value'],
output_type({ field_config }) {
return {
field_config: {
...field_config,
type: FieldType.Number
}
};
}
};