Skip to main content
Version: v2

TypeFactoryFunction Interface

Represents a function type in the type factory system.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/type-factory/alpha.

For more information about our API support guarantees, see here.

Signature​

export interface TypeFactoryFunction extends TypeFactoryType

Extends: TypeFactoryType

Properties​

PropertyAlertsModifiersTypeDescription
_kindAlphareadonly"function"The kind of type this represents.
parametersAlphareadonlyreadonly TypeFactoryFunctionParameter[]The function parameters.
restParameterAlphaoptional, readonlyTypeFactoryFunctionParameterOptional rest parameter for variable-length argument lists.
returnTypeAlphareadonlyTypeFactoryTypeThe function return type.

Property Details​

_kind​

The kind of type this represents.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly _kind: "function";

Type: "function"

parameters​

The function parameters.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly parameters: readonly TypeFactoryFunctionParameter[];

Type: readonly TypeFactoryFunctionParameter[]

restParameter​

Optional rest parameter for variable-length argument lists.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly restParameter?: TypeFactoryFunctionParameter;

Type: TypeFactoryFunctionParameter

returnType​

The function return type.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly returnType: TypeFactoryType;

Type: TypeFactoryType