Data-Mate: `Function Configs Interfaces Function Definition Config`
function-configs/interfaces.FunctionDefinitionConfig
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Hierarchy
FunctionDefinitionConfig
Table of contents
Properties
- accepts
- aliases
- argument_schema
- category
- description
- examples
- name
- required_arguments
- type
- validate_arguments
Properties
accepts
• Readonly
accepts: readonly FieldType
[]
Can be used in strongly typed contexts to throw early, some types or only compatible with a given operation
Defined in
data-mate/src/function-configs/interfaces.ts:138
aliases
• Optional
Readonly
aliases: readonly string
[]
Optionally specify other known aliases to this function
Defined in
data-mate/src/function-configs/interfaces.ts:102
argument_schema
• Optional
Readonly
argument_schema: DataTypeFields
Used for validating and defining the types of the input arguments, please include description field when creating the schema
Defined in
data-mate/src/function-configs/interfaces.ts:126
category
• Readonly
category: FunctionDefinitionCategory
The category of operation, for documentation purposes
Defined in
data-mate/src/function-configs/interfaces.ts:113
description
• Readonly
description: string
Used to generate documentation
Defined in
data-mate/src/function-configs/interfaces.ts:108
examples
• Optional
Readonly
examples: readonly FunctionDefinitionExample
<T
, unknown
>[]
Examples that will be used in the documentation and potentially in the automated tests. FIXME make this non-optional
Defined in
data-mate/src/function-configs/interfaces.ts:120
name
• Readonly
name: string
The name of the function, this should be considered case-insensitive, since some languages like SQL are case insensitive.
Defined in
data-mate/src/function-configs/interfaces.ts:97
required_arguments
• Optional
Readonly
required_arguments: readonly string
[]
Used to determine what of the possible args are required, as DataType configs does not have a mechanism to specify what is required
Defined in
data-mate/src/function-configs/interfaces.ts:132
type
• Readonly
type: FunctionDefinitionType
Type of operation that will be preformed
Defined in
data-mate/src/function-configs/interfaces.ts:105
validate_arguments
• Optional
Readonly
validate_arguments: (args
: T
) => void
Type declaration
▸ (args
): void
Used for additional custom validation of args, called after generic arg validation
Parameters
Name | Type |
---|---|
args | T |
Returns
void