Class: ConsumerParameterBuilder

Nautilus.ConsumerParameterBuilder

Implements

• IBuilder<ConsumerParameter>

Constructors

constructor

• new ConsumerParameterBuilder()

Properties

consumerParameter

• Private consumerParameter: NautilusConsumerParameter

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:7

Methods

addOption

▸ addOption(option): ConsumerParameterBuilder

Parameters

Name	Type
option	ConsumerParameterSelectOption

Returns

ConsumerParameterBuilder

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:49

---

build

▸ build(): { default: string ; description: string ; label: string ; name: string ; required: boolean = false; type: "number" | "boolean" | "text" | "select" } | { default: string ; description: string ; label: string ; name: string ; options: string ; required: boolean = false; type: "number" | "boolean" | "text" | "select" }

Returns

{ default: string ; description: string ; label: string ; name: string ; required: boolean = false; type: "number" | "boolean" | "text" | "select" } | { default: string ; description: string ; label: string ; name: string ; options: string ; required: boolean = false; type: "number" | "boolean" | "text" | "select" }

Implementation of

IBuilder.build

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:61

---

reset

▸ reset(): void

Returns

void

Implementation of

IBuilder.reset

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:9

---

setDefault

▸ setDefault(value): ConsumerParameterBuilder

Parameters

Name	Type
value	string | number | boolean

Returns

ConsumerParameterBuilder

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:43

---

setDescription

▸ setDescription(description): ConsumerParameterBuilder

Parameters

Name	Type
description	string

Returns

ConsumerParameterBuilder

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:25

---

setLabel

▸ setLabel(label): ConsumerParameterBuilder

Parameters

Name	Type
label	string

Returns

ConsumerParameterBuilder

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:31

---

setName

▸ setName(name): ConsumerParameterBuilder

Parameters

Name	Type
name	string

Returns

ConsumerParameterBuilder

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:19

---

setRequired

▸ setRequired(required): ConsumerParameterBuilder

Parameters

Name	Type
required	boolean

Returns

ConsumerParameterBuilder

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:37

---

setType

▸ setType(type): ConsumerParameterBuilder

Parameters

Name	Type
type	"number" | "boolean" | "text" | "select"

Returns

ConsumerParameterBuilder

Defined in

src/Nautilus/Asset/ConsumerParameters/ConsumerParameterBuilder.ts:13