tuil
ReferencePackages@mwillbanks/tuil-cellAPI

NativeCellAcceleratorOptions

interface exported by @mwillbanks/tuil-cell.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-cell.

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

MemberTypeRequiredDescriptionRelated types
libraryPathsreadonly string[] | undefinedNoThe libraryPaths member uses the readonly string[] | undefined contract.
exists((path: string) => boolean | Promise<boolean>) | undefinedNoThe exists member uses the ((path: string) => boolean | Promise<boolean>) | undefined contract.
open((path: string) => NativeCellDiffLibrary | Promise<NativeCellDiffLibrary>) | undefinedNoThe open member uses the ((path: string) => NativeCellDiffLibrary | Promise<NativeCellDiffLibrary>) | undefined contract.
platformstring | undefinedNoThe platform member uses the string | undefined contract.
architecturestring | undefinedNoThe architecture member uses the string | undefined contract.
envReadonly<Record<string, string | undefined>> | undefinedNoThe env member uses the Readonly<Record<string, string | undefined>> | undefined contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

No package-local related types.

Source

View the secondary source reference

Package

@mwillbanks/tuil-cell

On this page