# TypeScript · TypeDoc

Real TypeDoc output from the checked-in typescript fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.

> Source: https://appgram.github.io/docsy/versions/current/es/typescript-sdk  
> Language: typescript  
> Symbols: 13 across 6 categories

## Categories

- [Enums](#enums) — 1 items
- [Mood](#mood) — 2 items
- [Classes](#classes) — 1 items
- [Greeter](#greeter) — 6 items
- [Interfaces](#interfaces) — 1 items
- [GreetingOptions](#greetingoptions) — 2 items

## Enums

### `Mood`  <sub>enum</sub>

Supported greeting moods.

**Values** — `Formal`, `Friendly`

```typescript
enum Mood
```

## Mood

### `Mood.Formal`  <sub>enum-member</sub>

```typescript
Formal: "formal"
```

---

### `Mood.Friendly`  <sub>enum-member</sub>

```typescript
Friendly: "friendly"
```

## Classes

### `Greeter`  <sub>class</sub>

Build personalized greetings without network access.

**Remarks** — Create one greeter per locale. Prefix changes apply to future greetings.

**Properties**

| Name | Type | Required | Description | Default |

| --- | --- | --- | --- | --- |

| `prefix` | `string` | ✓ | Greeting prefix. | `'Hello'` |

**Methods**

- `constructor` → `Greeter`

- `greet` → `string`  
  Greet a reader.

  - `name: string` — Reader name.

- `greetChecked` → `string`  
  Validate a name before greeting it.

  - `name: string`

- `greetMany` → `string`  
  Greet several readers while preserving input order.

  - `names: string[]` — Reader names.

  - `separator: string` (optional) — Separator between greetings.

- `hello` → `string`  
  Use greet instead.

  - `name: string`

```typescript
class Greeter
```

**Example**

```typescript
const greeter = new Greeter();
greeter.prefix = 'Welcome';
console.log(greeter.greet('Docsy'));
```

## Greeter

### `Greeter.constructor`  <sub>constructor</sub>

**Returns** — `Greeter`

```typescript
constructor(): Greeter
```

---

### `Greeter.greet`  <sub>method</sub>

Greet a reader.

**Parameters**

| Name | Type | Required | Description |

| --- | --- | --- | --- |

| `name` | `string` | ✓ | Reader name. |

**Returns** — `string` — A friendly greeting.

```typescript
greet(name: string): string
```

**Example**

```typescript
new Greeter().greet('Docsy');
```

---

### `Greeter.greetChecked`  <sub>method</sub>

Validate a name before greeting it.

**Errors**

- `Error` — when the name is empty.

**Parameters**

| Name | Type | Required | Description |

| --- | --- | --- | --- |

| `name` | `string` | ✓ |  |

**Returns** — `string`

```typescript
greetChecked(name: string): string
```

**Example**

```typescript
new Greeter().greetChecked('Ada');
```

---

### `Greeter.greetMany`  <sub>method</sub>

Greet several readers while preserving input order.

**Parameters**

| Name | Type | Required | Description |

| --- | --- | --- | --- |

| `names` | `string[]` | ✓ | Reader names. |

| `separator` | `string` |  | Separator between greetings. |

**Returns** — `string` — Joined greetings.

```typescript
greetMany(names: string[], separator: string): string
```

**Example**

```typescript
new Greeter().greetMany(['Ada', 'Linus'], ' / ');
```

---

### `Greeter.hello`  <sub>method</sub>

Use greet instead.

> **Deprecated**: Use greet(name) for consistent formatting.

**Parameters**

| Name | Type | Required | Description |

| --- | --- | --- | --- |

| `name` | `string` | ✓ |  |

**Returns** — `string`

```typescript
hello(name: string): string
```

---

### `Greeter.prefix`  <sub>property</sub>

Greeting prefix.

```typescript
prefix: string
```

## Interfaces

### `GreetingOptions`  <sub>interface</sub>

Options accepted by greeting integrations.

**Properties**

| Name | Type | Required | Description | Default |

| --- | --- | --- | --- | --- |

| `mood` | `Mood` | ✓ | Desired greeting tone. |  |

| `prefix` | `string` |  | Optional salutation override. |  |

```typescript
interface GreetingOptions
```

## GreetingOptions

### `GreetingOptions.mood`  <sub>property</sub>

Desired greeting tone.

```typescript
mood: Mood
```

---

### `GreetingOptions.prefix`  <sub>property</sub>

Optional salutation override.

```typescript
prefix: string
```