# NativeCellAcceleratorOptions

Source: /tuil/docs/reference/packages/cell/api/native-cell-accelerator-options
Locale: en

interface exported by @mwillbanks/tuil-cell.



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

## interface [#interface]

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

```ts
export interface NativeCellAcceleratorOptions {
  // Explicit candidates are tried in order before package-local prebuilds.
  readonly libraryPaths?: readonly string[];
  // Test/custom distribution seam; normal callers use Bun.file().exists().
  readonly exists?: (path: string) => boolean | Promise<boolean>;
  // Test/custom distribution seam; normal callers use Bun FFI.
  readonly open?: (
    path: string,
  ) => NativeCellDiffLibrary | Promise<NativeCellDiffLibrary>;
  readonly platform?: string;
  readonly architecture?: string;
  readonly env?: Readonly<Record<string, string | undefined>>;
}
```

## Members [#members]

| Member         | Type                                                                                       | Required | Description                                                                                                                     | Related types |
| -------------- | ------------------------------------------------------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `libraryPaths` | `readonly string[] \| undefined`                                                           | No       | The `libraryPaths` member uses the `readonly string[] \| undefined` contract.                                                   | —             |
| `exists`       | `((path: string) => boolean \| Promise<boolean>) \| undefined`                             | No       | The `exists` member uses the `((path: string) => boolean \| Promise<boolean>) \| undefined` contract.                           | —             |
| `open`         | `((path: string) => NativeCellDiffLibrary \| Promise<NativeCellDiffLibrary>) \| undefined` | No       | The `open` member uses the `((path: string) => NativeCellDiffLibrary \| Promise<NativeCellDiffLibrary>) \| undefined` contract. | —             |
| `platform`     | `string \| undefined`                                                                      | No       | The `platform` member uses the `string \| undefined` contract.                                                                  | —             |
| `architecture` | `string \| undefined`                                                                      | No       | The `architecture` member uses the `string \| undefined` contract.                                                              | —             |
| `env`          | `Readonly<Record<string, string \| undefined>> \| undefined`                               | No       | The `env` member uses the `Readonly<Record<string, string \| undefined>> \| undefined` contract.                                | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## 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)