Interface: PayloadParameter

Metadata for a controller method parameter that receives the entire event payload.

Extends

• BaseParameter

Properties

data?

optional data: string

Optional extra data for the decorator, such as the payload property key when type is MethodParamType.PARAM.

Inherited from

BaseParameter.data

---

defaultValue?

optional defaultValue: any

Inherited from

BaseParameter.defaultValue

---

index

index: number

The zero-based position of this parameter in the method signature.

Inherited from

BaseParameter.index

---

isOptional?

optional isOptional: boolean

Inherited from

BaseParameter.isOptional

---

metatype?

optional metatype: Function

Inherited from

BaseParameter.metatype

---

method?

optional method: string

Inherited from

BaseParameter.method

---

type

type: PAYLOAD

The parameter kind: inject the full payload object.

Overrides

BaseParameter.type