[I] Operation
A callable API signature, declared in a namespace or owned by an interface.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Modifier | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|---|
creating? | public | true | If the type is currently being created. | - | BaseType.creating |
decorators | public | DecoratorApplication[] | Applications used when finishing this type, including copied or synthesized applications. | - | DecoratedType.decorators |
entityKind | readonly | "Type" | Distinguishes semantic types from values and parameter constraints. | - | BaseType.entityKind |
instantiationParameters? | public | Type[] | Legacy instantiation metadata. The compiler’s type checker does not populate this field, so its absence does not indicate whether this type is a template instance. | - | BaseType.instantiationParameters |
interface? | public | Interface | Owning interface, or absent for a namespace-level operation. | - | - |
isFinished | public | boolean | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | BaseType.isFinished |
kind | public | "Operation" | Discriminant for API operation signatures rather than TypeSpec function values. | BaseType.kind | - |
name | public | string | Local operation name, excluding namespace and interface qualifiers. | - | - |
namespace? | public | Namespace | Containing namespace, including for operations declared inside an interface. | - | - |
node? | public | OperationStatementNode | Node used to construct this type. If the node is undefined it means the type was dynamically built. With typekit for example. | BaseType.node | - |
parameters | public | Model | Model whose properties describe the operation’s ordered parameters. | - | - |
returnType | public | Type | Result type, including the void intrinsic for an operation without a return value. | - | - |
sourceOperation? | public | Operation | The operation that is referenced via op is. | - | - |
templateMapper? | public | TypeMapper | Argument substitutions for an instantiation; absent on an uninstantiated declaration. | - | TemplatedTypeBase.templateMapper |
templateNode? | public | Node | Originating template node, when retained separately from the type’s source node. | - | TemplatedTypeBase.templateNode |