@typed/fp/docs/modules/Disposable.ts.md

Data Structures and Resources for fp-ts

---
title: Disposable.ts
nav_order: 11
parent: Modules
---

## Disposable overview

Disposable is an interface for representing resources which can be synchronously disposed of.

Added in v0.9.2

---

<h2 class="text-delta">Table of contents</h2>

- [Combinator](#combinator)
  - [undisposable](#undisposable)
- [Constructor](#constructor)
  - [settable](#settable)
- [Model](#model)
  - [Disposable (type alias)](#disposable-type-alias)
  - [SettableDisposable (interface)](#settabledisposable-interface)

---

# Combinator

## undisposable

Wrap a non-Disposable function into a Disposable-returning function

**Signature**

```ts
export declare const undisposable: <F extends FunctionN<readonly any[], any>>(
  fn: F,
) => (...args: ArgsOf<F>) => types.Disposable
```

Added in v0.9.2

# Constructor

## settable

Construct a SettableDisposable

**Signature**

```ts
export declare function settable(): SettableDisposable
```

Added in v0.9.2

# Model

## Disposable (type alias)

Re-export of @most/core's Disposable interface

**Signature**

```ts
export type Disposable = types.Disposable
```

Added in v0.11.0

## SettableDisposable (interface)

A Disposable that works in a more imperative manner. Can be useful when coercing external libraries
or using promises.

**Signature**

```ts
export interface SettableDisposable extends types.Disposable {
  readonly addDisposable: (disposable: types.Disposable) => types.Disposable
  readonly isDisposed: () => boolean
}
```

Added in v0.9.2