Logo Xantham

FsTypeRef Type

The F# type written at a reference position. Phase B covers primitives, `option`, arrays, delegates (D5) and references to declarations this run generates; everything else widens to `FsObj` with a finding saying so.

Union cases

Union case Description

FsApp(string, FsTypeRef list)

Full Usage: FsApp(string, FsTypeRef list)

Parameters:

A generic declaration applied to arguments: `Box` (§4.9). The checker substitutes members eagerly, so this is written only when the instantiation's target is itself a declaration this run generates; otherwise the expansion stands on its own.

Item1 : string
Item2 : FsTypeRef list

FsArray FsTypeRef

Full Usage: FsArray FsTypeRef

Parameters:
Item : FsTypeRef

FsBigInt

Full Usage: FsBigInt

TypeScript's `bigint`. Exact: Fable 5 compiles F# `bigint` to the native JavaScript `BigInt` - read off the emitted `BigInt.js` (`typeof x === "bigint"`, `fromInt32 n` is `BigInt(n)`) and run against a JS object handing one over, not recalled.

FsBool

Full Usage: FsBool

FsBranded(primitive, measure)

Full Usage: FsBranded(primitive, measure)

Parameters:

A primitive carrying a unit of measure: the F# rendering of a TypeScript branding intersection (§4.6, D11). `string & { __brand: "UserId" }` is a value that is a string at runtime and refuses to substitute for another string at compile time, which is what a measure is. The measure name is a declaration this run emits.

primitive : FsTypeRef
measure : string

FsDelegate(FsTypeRef list, FsTypeRef)

Full Usage: FsDelegate(FsTypeRef list, FsTypeRef)

Parameters:

A callback as a delegate (D5): parameter types and return. Renders as `System.Action`/`System.Func` so the arity is guaranteed at the Fable boundary.

Item1 : FsTypeRef list
Item2 : FsTypeRef

FsErasedUnion FsTypeRef list

Full Usage: FsErasedUnion FsTypeRef list

Parameters:

A heterogeneous union as Fable's erased `U2`-`U4` (D4, §4.5(4)). The threshold is four; wider unions widen to `obj`. Arms are distinct - a union whose arms collapse to one F# type is that type instead.

Item : FsTypeRef list

FsFloat

Full Usage: FsFloat

FsNamed string

Full Usage: FsNamed string

Parameters:
    Item : string

Item : string

FsObj

Full Usage: FsObj

FsOption FsTypeRef

Full Usage: FsOption FsTypeRef

Parameters:
Item : FsTypeRef

FsString

Full Usage: FsString

FsTuple FsTypeRef list

Full Usage: FsTuple FsTypeRef list

Parameters:

A fixed-length tuple (D7, §4.12): Fable compiles an F# tuple to a JS array, so the mapping is exact. Optional tail elements arrive already `option`-wrapped, because the checker hands them over as `T | undefined`.

Item : FsTypeRef list

FsTypeVar string

Full Usage: FsTypeVar string

Parameters:
    Item : string

A type variable in scope - a type parameter of the declaration being shaped (§4.9). Carries the name TypeScript spelled, without the leading tick the renderer adds.

Item : string

FsUnit

Full Usage: FsUnit

Instance members

Instance member Description

this.IsFsApp

Full Usage: this.IsFsApp

Returns: bool
Returns: bool

this.IsFsArray

Full Usage: this.IsFsArray

Returns: bool
Returns: bool

this.IsFsBigInt

Full Usage: this.IsFsBigInt

Returns: bool
Returns: bool

this.IsFsBool

Full Usage: this.IsFsBool

Returns: bool
Returns: bool

this.IsFsBranded

Full Usage: this.IsFsBranded

Returns: bool
Returns: bool

this.IsFsDelegate

Full Usage: this.IsFsDelegate

Returns: bool
Returns: bool

this.IsFsErasedUnion

Full Usage: this.IsFsErasedUnion

Returns: bool
Returns: bool

this.IsFsFloat

Full Usage: this.IsFsFloat

Returns: bool
Returns: bool

this.IsFsNamed

Full Usage: this.IsFsNamed

Returns: bool
Returns: bool

this.IsFsObj

Full Usage: this.IsFsObj

Returns: bool
Returns: bool

this.IsFsOption

Full Usage: this.IsFsOption

Returns: bool
Returns: bool

this.IsFsString

Full Usage: this.IsFsString

Returns: bool
Returns: bool

this.IsFsTuple

Full Usage: this.IsFsTuple

Returns: bool
Returns: bool

this.IsFsTypeVar

Full Usage: this.IsFsTypeVar

Returns: bool
Returns: bool

this.IsFsUnit

Full Usage: this.IsFsUnit

Returns: bool
Returns: bool

Type something to start searching.