Back to Sourcery

MethodParameter

docs/Classes/MethodParameter.html

2.3.04.1 KB
Original Source

MethodParameter

@objcMembers
public class MethodParameter : NSObject, SourceryModel, Typed, Annotated, Diffable
extension MethodParameter: NSCoding

Describes method parameter

`

                argumentLabel
                `

Parameter external name

Declaration

Swift

public var argumentLabel: String?

`

                name
                `

Parameter internal name

Declaration

Swift

public let name: String

`

                typeName
                `

Parameter type name

Declaration

Swift

public let typeName: TypeName

`

                inout
                `

Parameter flag whether it’s inout or not

Declaration

Swift

public let `inout`: Bool

`

                isVariadic
                `

Is this variadic parameter?

Declaration

Swift

public let isVariadic: Bool

`

                type
                `

Parameter type, if known

Declaration

Swift

public var type: Type?

`

                typeAttributes
                `

Parameter type attributes, i.e. @escaping

Declaration

Swift

public var typeAttributes: AttributeList { get }

`

                defaultValue
                `

Method parameter default value expression

Declaration

Swift

public var defaultValue: String?

`

                annotations
                `

Annotations, that were created with // sourcery: annotation1, other = “annotation value”, alterantive = 2

Declaration

Swift

public var annotations: Annotations

`

                index
                `

Method parameter index in the argument list

Declaration

Swift

public var index: Int

`

                asSource
                `

Declaration

Swift

public var asSource: String { get }

`

                diffAgainst(_:)
                `

Declaration

Swift

public func diffAgainst(_ object: Any?) -> DiffableResult

`

                isOptional
                `

Whether type is optional. Shorthand for typeName.isOptional

Declaration

Swift

public var isOptional: Bool { get }

`

                isImplicitlyUnwrappedOptional
                `

Whether type is implicitly unwrapped optional. Shorthand for typeName.isImplicitlyUnwrappedOptional

Declaration

Swift

public var isImplicitlyUnwrappedOptional: Bool { get }

`

                unwrappedTypeName
                `

Type name without attributes and optional type information. Shorthand for typeName.unwrappedTypeName

Declaration

Swift

public var unwrappedTypeName: String { get }

`

                actualTypeName
                `

Actual type name if declaration uses typealias, otherwise just a typeName. Shorthand for typeName.actualTypeName

Declaration

Swift

public var actualTypeName: TypeName? { get }

`

                isTuple
                `

Whether type is a tuple. Shorthand for typeName.isTuple

Declaration

Swift

public var isTuple: Bool { get }

`

                isClosure
                `

Whether type is a closure. Shorthand for typeName.isClosure

Declaration

Swift

public var isClosure: Bool { get }

`

                isArray
                `

Whether type is an array. Shorthand for typeName.isArray

Declaration

Swift

public var isArray: Bool { get }

`

                isSet
                `

Whether type is a set. Shorthand for typeName.isSet

Declaration

Swift

public var isSet: Bool { get }

`

                isDictionary
                `

Whether type is a dictionary. Shorthand for typeName.isDictionary

Declaration

Swift

public var isDictionary: Bool { get }

Copyright © 2016-2021 Pixle. All rights reserved.

Generated by jazzy ♪♫ v0.14.0, a Realm project.