`VariantLinkResult`

Interface in Variants

What happened to one variant.

import type { VariantLinkResult } from 'typeshade'

The signature, the description and the examples come from the compiler's own source at commit 26de7be8.

Syntax

interface VariantLinkResult {
  readonly key: string;
  readonly ok: boolean;
  readonly failedAt?: 'emit' | 'vertex' | 'fragment' | 'link';
  readonly log?: string;
}

Instance properties

keyread only string: The variant’s key in family.keys, the same id a pipeline cache would use for it.
okread only boolean
failedAtoptionalread only 'emit' | 'vertex' | 'fragment' | 'link': Which step failed. Absent when ok. 'emit' means the DSL threw before any GL call, which is a different bug from a driver rejecting valid-looking source.
logoptionalread only string: The driver’s log, or the thrown message. Absent when ok.

Source

src/core/variant-link.ts, line 57, at commit 26de7be8

Edit this page Report a problem