Class: StringPrompt

weave / StringPrompt

​

Hierarchy

• Prompt ↳ StringPrompt

​

Table of contents

​

Constructors

• constructor

​

Properties

• __savedRef
• content

​

Accessors

• description
• name

​

Methods

• format
• saveAttrs

​

Constructors

​

constructor

• new StringPrompt(parameters): StringPrompt

​

Parameters

Name	Type
parameters	StringPromptParameters

​

Returns

StringPrompt

​

Overrides

Prompt.constructor

​

Defined in

prompt.ts:16

​

Properties

​

__savedRef

• Optional __savedRef: ObjectRef | Promise<ObjectRef>

​

Inherited from

Prompt.__savedRef

​

Defined in

weaveObject.ts:49

---

​

content

• content: string

​

Defined in

prompt.ts:14

​

Accessors

​

description

• get description(): undefined | string

​

Returns

undefined | string

​

Inherited from

Prompt.description

​

Defined in

weaveObject.ts:76

---

​

name

• get name(): string

​

Returns

string

​

Inherited from

Prompt.name

​

Defined in

weaveObject.ts:72

​

Methods

​

format

▸ format(values?): string

​

Parameters

Name	Type
values	Record<string, any>

​

Returns

string

​

Defined in

prompt.ts:21

---

​

saveAttrs

▸ saveAttrs(): Object

​

Returns

Object

​

Inherited from

Prompt.saveAttrs

​

Defined in

weaveObject.ts:53