Class: StringPrompt

TypeScript SDK reference

weave / StringPrompt

Hierarchy

• Prompt

  ↳ StringPrompt

Table of contents

Constructors

• constructor

Properties

• __savedRef
• content

Accessors

• description
• name

Methods

• format
• saveAttrs
• get

Constructors

constructor

• new StringPrompt(parameters): StringPrompt

Parameters

Name	Type
parameters	StringPromptParameters

Returns

StringPrompt

Overrides

Prompt.constructor

Defined in

prompt.ts:17

Properties

__savedRef

• Optional __savedRef: ObjectRef | Promise<ObjectRef>

Inherited from

Prompt.__savedRef

Defined in

weaveObject.ts:73

---

content

• content: string

Defined in

prompt.ts:15

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

Prompt.description

Defined in

weaveObject.ts:100

---

name

• get name(): string

Returns

string

Inherited from

Prompt.name

Defined in

weaveObject.ts:96

Methods

format

▸ format(values?): string

Parameters

Name	Type
values	Record<string, any>

Returns

string

Defined in

prompt.ts:22

---

saveAttrs

▸ saveAttrs(): Object

Returns

Object

Inherited from

Prompt.saveAttrs

Defined in

weaveObject.ts:77

---

get

▸ get(client, uri): Promise<StringPrompt>

Parameters

Name	Type
client	WeaveClient
uri	string

Returns

Promise<StringPrompt>

Defined in

prompt.ts:26