DecoratorApi Class

Interface which contains essential decorator function building blocks to extend for creating new function app or blueprint classes.

Inheritance
DecoratorApi

Constructor

DecoratorApi(*args, **kwargs)

Methods

function_name

Optional: Sets name of the Function object. If not set, it will default to the name of the method name.

additional setting fields :return: Decorator function.

http_type

Set http type of the Function object.

function_name

Optional: Sets name of the Function object. If not set, it will default to the name of the method name.

additional setting fields :return: Decorator function.

function_name(name: str, setting_extra_fields: Dict[str, Any] | None = None) -> Callable[[...], Any]

Parameters

Name Description
name
Required

Name of the function.

setting_extra_fields
Required

Keyword arguments for specifying

Default value: None

http_type

Set http type of the Function object.

http_type(http_type: str) -> Callable[[...], Any]

Parameters

Name Description
http_type
Required

Http type of the function.

Returns

Type Description

Decorator function.

Attributes

app_script_file

Name of function app script file in which all the functions are defined.

Script file defined here is for placeholder purpose, please refer to worker defined script file path as the single point of truth.

Returns

Type Description

Script file name.