> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-docs-1778-mysql-updates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: StringPrompt

> TypeScript SDK reference

[weave](../) / StringPrompt

## Hierarchy

* `Prompt`

  ↳ `StringPrompt`

## Table of contents

### Constructors

* [constructor](./StringPrompt#constructor)

### Properties

* [\_\_savedRef](./StringPrompt#__savedref)
* [content](./StringPrompt#content)

### Accessors

* [description](./StringPrompt#description)
* [name](./StringPrompt#name)

### Methods

* [format](./StringPrompt#format)
* [saveAttrs](./StringPrompt#saveattrs)

## Constructors

### constructor

• **new StringPrompt**(`parameters`): [`StringPrompt`](./StringPrompt)

#### Parameters

| Name         | Type                     |
| :----------- | :----------------------- |
| `parameters` | `StringPromptParameters` |

#### Returns

[`StringPrompt`](./StringPrompt)

#### Overrides

Prompt.constructor

#### Defined in

[prompt.ts:16](https://github.com/wandb/weave/blob/5d9590d2658eeb69c9c9f04342e107bf9a0a4c90/sdks/node/src/prompt.ts#L16)

## Properties

### \_\_savedRef

• `Optional` **\_\_savedRef**: `ObjectRef` | `Promise`\<`ObjectRef`>

#### Inherited from

Prompt.\_\_savedRef

#### Defined in

[weaveObject.ts:49](https://github.com/wandb/weave/blob/5d9590d2658eeb69c9c9f04342e107bf9a0a4c90/sdks/node/src/weaveObject.ts#L49)

***

### content

• **content**: `string`

#### Defined in

[prompt.ts:14](https://github.com/wandb/weave/blob/5d9590d2658eeb69c9c9f04342e107bf9a0a4c90/sdks/node/src/prompt.ts#L14)

## Accessors

### description

• `get` **description**(): `undefined` | `string`

#### Returns

`undefined` | `string`

#### Inherited from

Prompt.description

#### Defined in

[weaveObject.ts:76](https://github.com/wandb/weave/blob/5d9590d2658eeb69c9c9f04342e107bf9a0a4c90/sdks/node/src/weaveObject.ts#L76)

***

### name

• `get` **name**(): `string`

#### Returns

`string`

#### Inherited from

Prompt.name

#### Defined in

[weaveObject.ts:72](https://github.com/wandb/weave/blob/5d9590d2658eeb69c9c9f04342e107bf9a0a4c90/sdks/node/src/weaveObject.ts#L72)

## Methods

### format

▸ **format**(`values?`): `string`

#### Parameters

| Name     | Type                       |
| :------- | :------------------------- |
| `values` | `Record`\<`string`, `any`> |

#### Returns

`string`

#### Defined in

[prompt.ts:21](https://github.com/wandb/weave/blob/5d9590d2658eeb69c9c9f04342e107bf9a0a4c90/sdks/node/src/prompt.ts#L21)

***

### saveAttrs

▸ **saveAttrs**(): `Object`

#### Returns

`Object`

#### Inherited from

Prompt.saveAttrs

#### Defined in

[weaveObject.ts:53](https://github.com/wandb/weave/blob/5d9590d2658eeb69c9c9f04342e107bf9a0a4c90/sdks/node/src/weaveObject.ts#L53)