Interface FunctionDefArgs

Configuration arguments for creating a Python function.

interface FunctionDefArgs {
    name: string;
    parameters?: Parameter[];
    decorators?: Decorator[];
    docstring?: string;
    returnType?: ClassReference;
    isStatic?: boolean;
    isClassMethod?: boolean;
    isAsync?: boolean;
}

Index

Properties

name parameters? decorators? docstring? returnType? isStatic? isClassMethod? isAsync?

Properties

name

name: string

The name of the function

`Optional`parameters

parameters?: Parameter[]

The parameters of the function

`Optional`decorators

decorators?: Decorator[]

Decorators to apply to the function

`Optional`docstring

docstring?: string

Documentation string for the function

`Optional`returnType

returnType?: ClassReference

Return type annotation

`Optional`isStatic

isStatic?: boolean

Whether this is a static method

`Optional`isClassMethod

isClassMethod?: boolean

Whether this is a class method

`Optional`isAsync

isAsync?: boolean

Whether this is an async function