# SubscriptionEvents

URL: https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/subscriptionevents/

Defined in: [relay-sdks/ts/src/subscription-events.ts:32](https://github.com/caprids/relay-sdks/blob/main/ts/src/subscription-events.ts#L32)

Single-consumer iterator owning one subscription, never the shared connection.

## Extends

- `AsyncIterableIterator`\<[`SubscriptionEvent`](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionevent/)\>

## Methods

### \[asyncIterator\]()

```ts
[asyncIterator](): AsyncIterableIterator<SubscriptionEvent, any, any>;
```

Defined in: typescript/lib/lib.es2018.asynciterable.d.ts:43

#### Returns

`AsyncIterableIterator`\<[`SubscriptionEvent`](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionevent/), `any`, `any`\>

#### Inherited from

`AsyncIterableIterator.[asyncIterator]`

***

### close()

```ts
close(): void;
```

Defined in: [relay-sdks/ts/src/subscription-events.ts:34](https://github.com/caprids/relay-sdks/blob/main/ts/src/subscription-events.ts#L34)

Discard queued events and settle pending reads as EOF. Idempotent.

#### Returns

`void`

***

### next()

```ts
next(...__namedParameters): Promise<IteratorResult<SubscriptionEvent, any>>;
```

Defined in: typescript/lib/lib.es2018.asynciterable.d.ts:30

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`__namedParameters` | \[\] \| \[`any`\] |

#### Returns

`Promise`\<`IteratorResult`\<[`SubscriptionEvent`](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionevent/), `any`\>\>

#### Inherited from

`AsyncIterableIterator.next`

***

### return()

```ts
return(): Promise<IteratorResult<SubscriptionEvent, any>>;
```

Defined in: [relay-sdks/ts/src/subscription-events.ts:36](https://github.com/caprids/relay-sdks/blob/main/ts/src/subscription-events.ts#L36)

Called by `for await` on `break` or a throw: discards queued events, cancels the subscription, resolves done.

#### Returns

`Promise`\<`IteratorResult`\<[`SubscriptionEvent`](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionevent/), `any`\>\>

#### Overrides

`AsyncIterableIterator.return`

***

### throw()?

```ts
throw?(e?): Promise<IteratorResult<SubscriptionEvent, any>>;
```

Defined in: typescript/lib/lib.es2018.asynciterable.d.ts:32

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `e?` | `any` |

#### Returns

`Promise`\<`IteratorResult`\<[`SubscriptionEvent`](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionevent/), `any`\>\>

#### Inherited from

`AsyncIterableIterator.throw`