tuil
ReferencePackages@mwillbanks/tuil-ghostty-webAPI

TuilGhosttyStoryOptions

interface exported by @mwillbanks/tuil-ghostty-web.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-ghostty-web.

export interface TuilGhosttyStoryOptions {
  readonly storyId: string;
  readonly variant: string;
  readonly args?: Readonly<Record<string, unknown>>;
  readonly controls?: Readonly<Record<string, unknown>>;
}

Members

MemberTypeRequiredDescriptionRelated types
storyIdstringYesThe storyId member uses the string contract.
variantstringYesThe variant member uses the string contract.
argsReadonly<Record<string, unknown>> | undefinedNoThe args member uses the Readonly<Record<string, unknown>> | undefined contract.
controlsReadonly<Record<string, unknown>> | undefinedNoThe controls member uses the Readonly<Record<string, unknown>> | 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-ghostty-web

On this page