kibana/docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.expressionfunction.md

Home > kibana-plugin-plugins-expressions-server > ExpressionFunction

ExpressionFunction class

Signature:

export declare class ExpressionFunction 

Constructors

Constructor	Modifiers	Description
(constructor)(functionDefinition)		Constructs a new instance of the ExpressionFunction class

Properties

Property	Modifiers	Type	Description
accepts		(type: string) => boolean
aliases		string[]	Aliases that can be used instead of name.
args		Record<string, ExpressionFunctionParameter>	Specification of expression function parameters.
fn		(input: ExpressionValue, params: Record<string, any>, handlers: object) => ExpressionValue	Function to run function (context, args)
help		string	A short help text.
inputTypes		string[] | undefined	Type of inputs that this function supports.
name		string	Name of function
type		string	Return type of function. This SHOULD be supplied. We use it for UI and autocomplete hinting. We may also use it for optimizations in the future.