# encodeCellOutput

Source: /tuil/docs/reference/packages/cell/api/encode-cell-output
Locale: en

function exported by @mwillbanks/tuil-cell.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-cell`.

```ts
export function encodeCellOutput(
  frame: CellFrame,
  mode: CellOutputMode,
  previous?: CellFrame,
): RendererOutput;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member     | Type             | Required | Description                                    | Related types                                                          |
| ---------- | ---------------- | -------- | ---------------------------------------------- | ---------------------------------------------------------------------- |
| `frame`    | `CellFrame`      | Yes      | Supplies the `frame` value as `CellFrame`.     | [`CellFrame`](/tuil/docs/reference/packages/cell/api/cell-frame)            |
| `mode`     | `CellOutputMode` | Yes      | Supplies the `mode` value as `CellOutputMode`. | [`CellOutputMode`](/tuil/docs/reference/packages/cell/api/cell-output-mode) |
| `previous` | `CellFrame`      | No       | Supplies the `previous` value as `CellFrame`.  | [`CellFrame`](/tuil/docs/reference/packages/cell/api/cell-frame)            |

## Returns [#returns]

`RendererOutput` — Returns a value that satisfies `RendererOutput`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`CellFrame`](/tuil/docs/reference/packages/cell/api/cell-frame)
* [`CellOutputMode`](/tuil/docs/reference/packages/cell/api/cell-output-mode)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/cell/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-cell](/tuil/docs/reference/packages/cell)