---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/FormatCapability.md
description: A formatter capability declaration.
---

# Interface: FormatCapability

Defined in: [src/batteries/dev\_tools/types.ts:88](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L88)

A formatter capability declaration.

## Properties

| Property                                      | Type                                               | Description                                                                      | Defined in                                                                                                               |
| --------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|  `extensions` | readonly `string`\[]                                | Extensions participating in this selection pass.                                 | [src/batteries/dev\_tools/types.ts:90](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L90) |
|  `generates?`  | `boolean`                                          | Allows output when the invocation has no input paths.                            | [src/batteries/dev\_tools/types.ts:98](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L98) |
|  `inPlace?`      | `boolean`                                          | Selects disk-mutating execution through the restricted access façade.            | [src/batteries/dev\_tools/types.ts:92](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L92) |
|  `needs?`          | readonly (`"delete"` | `"rename"` | `"mkdir"`)\[] | Filesystem operations granted to an in-place capability; duplicates are ignored. | [src/batteries/dev\_tools/types.ts:96](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L96) |
|  `scope?`          | readonly `string`\[]                                | Glob permission used for selection and in-place authorization.                   | [src/batteries/dev\_tools/types.ts:94](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L94) |

## Methods

### format()

```ts
format(request: FormatRequest): Promise<WorkspaceDelta>;
```

Defined in: [src/batteries/dev\_tools/types.ts:100](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L100)

Formats the supplied paths and returns a workspace delta; it must not mutate the map directly.

#### Parameters

| Parameter | Type                                |
| --------- | ----------------------------------- |
| `request` | [`FormatRequest`](FormatRequest.md) |

#### Returns

`Promise`<[`WorkspaceDelta`](WorkspaceDelta.md)>