TypeReference (Xantham)

TypeReference Type

Namespace: Xantham.Generator
Assembly: Xantham.Generator.dll
Base Type: obj
All Interfaces: IEquatable<TypeReference> , IStructuralEquatable , IComparable<TypeReference> , IComparable , IStructuralComparable , IFindingKind

`Shape.typeRef` and the helpers under it: what happens to a type at a reference position.

Union cases

Union case	Description
`AnonymousInMappedGroup` Full Usage: `AnonymousInMappedGroup`	Wave five, lane R. An anonymous shape in a mapped group. The destination binds names, and an anonymous shape has none.
`AnonymousInReferencedGroup` Full Usage: `AnonymousInReferencedGroup`
`AnyToObj` Full Usage: `AnyToObj`
`ArgumentNotASubtypeOfConstraint(argument, name, bound)` Full Usage: `ArgumentNotASubtypeOfConstraint(argument, name, bound)` Parameters: argument : `string` name : `string` bound : `string`	F# subtyping is nominal where TypeScript's is structural: an argument that merely has the constraint's members is FS0001 at the application, so it is written as the constraint, the way an argument that widened to `obj` already is. argument : `string` name : `string` bound : `string`
`ArgumentNotBoundWithConstraint(variable, name, bound)` Full Usage: `ArgumentNotBoundWithConstraint(variable, name, bound)` Parameters: variable : `string` name : `string` bound : `string`	variable : `string` name : `string` bound : `string`
`ArrayIntersectionMembersDropped dropped` Full Usage: `ArrayIntersectionMembersDropped dropped` Parameters: dropped : `int`	Wave three, lane H. An intersection whose operands include an array shape maps to the element array; members contributed by the other operands have no F# form on an array. dropped : `int`
`BigIntLiteralToBigInt` Full Usage: `BigIntLiteralToBigInt`
`CallableWithoutSignatures` Full Usage: `CallableWithoutSignatures`
`CallbackOverloadsFromFirst overloads` Full Usage: `CallbackOverloadsFromFirst overloads` Parameters: overloads : `int`	overloads : `int`
`ConditionalResolvedToBranch(conditional, branch)` Full Usage: `ConditionalResolvedToBranch(conditional, branch)` Parameters: conditional : `string` branch : `string`	Wave two, lane E. The negative of the above: the checker resolved the condition itself, so a branch is known and the mapping is the branch rather than `obj`. conditional : `string` branch : `string`
`ConditionalTypeDeferred conditional` Full Usage: `ConditionalTypeDeferred conditional` Parameters: conditional : `string`	Wave two, lane E. A conditional type is deferred: its branch is not chosen until the checker has an argument to test, and F# has no form that defers a type. The whole of `TR014` is now this construct, so it is named rather than reported as a flag. conditional : `string`
`ConstrainedArgumentWidened(name, bound)` Full Usage: `ConstrainedArgumentWidened(name, bound)` Parameters: name : `string` bound : `string`	name : `string` bound : `string`
`ConstructorObjectNotDeclared constructs` Full Usage: `ConstructorObjectNotDeclared constructs` Parameters: constructs : `string`	constructs : `string`
`EmptyIntersectionOperandReduced` Full Usage: `EmptyIntersectionOperandReduced`	Wave four, lane P. `X & {}` - the autocomplete idiom - reduces to `X`, and the reference renders `X`'s own form.
`EmptyUnionToObj` Full Usage: `EmptyUnionToObj`
`GlobalThisToObj` Full Usage: `GlobalThisToObj`
`IndexedAccessNoForm` Full Usage: `IndexedAccessNoForm`
`IntersectionCallableFlattened signatures` Full Usage: `IntersectionCallableFlattened signatures` Parameters: signatures : `int`	Wave four, lane P. An intersection of callable operands at a member position, rendered from the call signatures the operands carry. signatures : `int`
`IntersectionNotDeclared` Full Usage: `IntersectionNotDeclared`
`IntersectionOperandsIdentical` Full Usage: `IntersectionOperandsIdentical`	Wave four, lane P. Every operand of a flattened property is the same type, so the property renders that type.
`IntersectionOverNonObject` Full Usage: `IntersectionOverNonObject`
`KeyOfOpenOperand name` Full Usage: `KeyOfOpenOperand name` Parameters: name : `string`	name : `string`
`KeyOfOperandOutOfScope` Full Usage: `KeyOfOperandOutOfScope`
`LibBindingLoss note` Full Usage: `LibBindingLoss note` Parameters: note : `string`	note : `string`
`LibExtraTypeArgumentsDropped(name, given, fsharpName, arity)` Full Usage: `LibExtraTypeArgumentsDropped(name, given, fsharpName, arity)` Parameters: name : `string` given : `int` fsharpName : `string` arity : `int`	name : `string` given : `int` fsharpName : `string` arity : `int`
`LoneEnumMemberToFloat` Full Usage: `LoneEnumMemberToFloat`
`LoneEnumMemberToString` Full Usage: `LoneEnumMemberToString`
`MappedNameArityMismatch(name, given)` Full Usage: `MappedNameArityMismatch(name, given)` Parameters: name : `string` given : `int`	Wave five, lane R. The destination binding takes a different number of type arguments than the site applies. name : `string` given : `int`
`MissingFromTypeTable typeId` Full Usage: `MissingFromTypeTable typeId` Parameters: typeId : `int`	typeId : `int`
`NotAmongGeneratedDeclarations shown` Full Usage: `NotAmongGeneratedDeclarations shown` Parameters: shown : `string`	shown : `string`
`NullableHoistedToOption` Full Usage: `NullableHoistedToOption`
`NumericLiteralToFloat` Full Usage: `NumericLiteralToFloat`
`ObjectTypeToObj` Full Usage: `ObjectTypeToObj`
`ObjectWithoutMembers` Full Usage: `ObjectWithoutMembers`	Wave three, lane H. An object type declaring no members. `obj` admits everything the type does, so the reference is exact in surface and widened only in name. Distinct from `TR023`, which reports a declaration the run was expected to generate and did not.
`OnlyNullUndefinedToUnit` Full Usage: `OnlyNullUndefinedToUnit`
`PolymorphicThisAsDeclaringType` Full Usage: `PolymorphicThisAsDeclaringType`
`ReferencedArityUnconfirmed(name, given)` Full Usage: `ReferencedArityUnconfirmed(name, given)` Parameters: name : `string` given : `int`	Wave five, lane U. A reference into a `reference` group applies type arguments, and the group's declaration is resolved by identity only. name : `string` given : `int`
`SelfReferenceThroughUnnamed` Full Usage: `SelfReferenceThroughUnnamed`
`StringLiteralToString` Full Usage: `StringLiteralToString`
`StringMappingToString` Full Usage: `StringMappingToString`
`SymbolNoBinding` Full Usage: `SymbolNoBinding`
`TemplateLiteralToString` Full Usage: `TemplateLiteralToString`
`ThisOutsideDeclaration` Full Usage: `ThisOutsideDeclaration`
`TupleArityNoForm components` Full Usage: `TupleArityNoForm components` Parameters: components : `int`	components : `int`
`TupleRestToArray` Full Usage: `TupleRestToArray`
`TypeFlagsNotMapped flags` Full Usage: `TypeFlagsNotMapped flags` Parameters: flags : `string`	flags : `string`
`TypeNotResolved reason` Full Usage: `TypeNotResolved reason` Parameters: reason : `string`	reason : `string`
`TypeParameterOutOfScope` Full Usage: `TypeParameterOutOfScope`
`TypeParameterOutOfScopeToConstraint constraintName` Full Usage: `TypeParameterOutOfScopeToConstraint constraintName` Parameters: constraintName : `string`	constraintName : `string`
`UnionTooWide(arms, cap)` Full Usage: `UnionTooWide(arms, cap)` Parameters: arms : `int` cap : `int`	arms : `int` cap : `int`
`UnionWithObjArm` Full Usage: `UnionWithObjArm`
`UniqueSymbolNoBinding` Full Usage: `UniqueSymbolNoBinding`
`UnknownToObj` Full Usage: `UnknownToObj`
`UnnamedBrandToPrimitive` Full Usage: `UnnamedBrandToPrimitive`

Instance members

Instance member	Description
`this.IsAnonymousInMappedGroup` Full Usage: `this.IsAnonymousInMappedGroup` Returns: `bool`	Returns: `bool`
`this.IsAnonymousInReferencedGroup` Full Usage: `this.IsAnonymousInReferencedGroup` Returns: `bool`	Returns: `bool`
`this.IsAnyToObj` Full Usage: `this.IsAnyToObj` Returns: `bool`	Returns: `bool`
`this.IsArgumentNotASubtypeOfConstraint` Full Usage: `this.IsArgumentNotASubtypeOfConstraint` Returns: `bool`	Returns: `bool`
`this.IsArgumentNotBoundWithConstraint` Full Usage: `this.IsArgumentNotBoundWithConstraint` Returns: `bool`	Returns: `bool`
`this.IsArrayIntersectionMembersDropped` Full Usage: `this.IsArrayIntersectionMembersDropped` Returns: `bool`	Returns: `bool`
`this.IsBigIntLiteralToBigInt` Full Usage: `this.IsBigIntLiteralToBigInt` Returns: `bool`	Returns: `bool`
`this.IsCallableWithoutSignatures` Full Usage: `this.IsCallableWithoutSignatures` Returns: `bool`	Returns: `bool`
`this.IsCallbackOverloadsFromFirst` Full Usage: `this.IsCallbackOverloadsFromFirst` Returns: `bool`	Returns: `bool`
`this.IsConditionalResolvedToBranch` Full Usage: `this.IsConditionalResolvedToBranch` Returns: `bool`	Returns: `bool`
`this.IsConditionalTypeDeferred` Full Usage: `this.IsConditionalTypeDeferred` Returns: `bool`	Returns: `bool`
`this.IsConstrainedArgumentWidened` Full Usage: `this.IsConstrainedArgumentWidened` Returns: `bool`	Returns: `bool`
`this.IsConstructorObjectNotDeclared` Full Usage: `this.IsConstructorObjectNotDeclared` Returns: `bool`	Returns: `bool`
`this.IsEmptyIntersectionOperandReduced` Full Usage: `this.IsEmptyIntersectionOperandReduced` Returns: `bool`	Returns: `bool`
`this.IsEmptyUnionToObj` Full Usage: `this.IsEmptyUnionToObj` Returns: `bool`	Returns: `bool`
`this.IsGlobalThisToObj` Full Usage: `this.IsGlobalThisToObj` Returns: `bool`	Returns: `bool`
`this.IsIndexedAccessNoForm` Full Usage: `this.IsIndexedAccessNoForm` Returns: `bool`	Returns: `bool`
`this.IsIntersectionCallableFlattened` Full Usage: `this.IsIntersectionCallableFlattened` Returns: `bool`	Returns: `bool`
`this.IsIntersectionNotDeclared` Full Usage: `this.IsIntersectionNotDeclared` Returns: `bool`	Returns: `bool`
`this.IsIntersectionOperandsIdentical` Full Usage: `this.IsIntersectionOperandsIdentical` Returns: `bool`	Returns: `bool`
`this.IsIntersectionOverNonObject` Full Usage: `this.IsIntersectionOverNonObject` Returns: `bool`	Returns: `bool`
`this.IsKeyOfOpenOperand` Full Usage: `this.IsKeyOfOpenOperand` Returns: `bool`	Returns: `bool`
`this.IsKeyOfOperandOutOfScope` Full Usage: `this.IsKeyOfOperandOutOfScope` Returns: `bool`	Returns: `bool`
`this.IsLibBindingLoss` Full Usage: `this.IsLibBindingLoss` Returns: `bool`	Returns: `bool`
`this.IsLibExtraTypeArgumentsDropped` Full Usage: `this.IsLibExtraTypeArgumentsDropped` Returns: `bool`	Returns: `bool`
`this.IsLoneEnumMemberToFloat` Full Usage: `this.IsLoneEnumMemberToFloat` Returns: `bool`	Returns: `bool`
`this.IsLoneEnumMemberToString` Full Usage: `this.IsLoneEnumMemberToString` Returns: `bool`	Returns: `bool`
`this.IsMappedNameArityMismatch` Full Usage: `this.IsMappedNameArityMismatch` Returns: `bool`	Returns: `bool`
`this.IsMissingFromTypeTable` Full Usage: `this.IsMissingFromTypeTable` Returns: `bool`	Returns: `bool`
`this.IsNotAmongGeneratedDeclarations` Full Usage: `this.IsNotAmongGeneratedDeclarations` Returns: `bool`	Returns: `bool`
`this.IsNullableHoistedToOption` Full Usage: `this.IsNullableHoistedToOption` Returns: `bool`	Returns: `bool`
`this.IsNumericLiteralToFloat` Full Usage: `this.IsNumericLiteralToFloat` Returns: `bool`	Returns: `bool`
`this.IsObjectTypeToObj` Full Usage: `this.IsObjectTypeToObj` Returns: `bool`	Returns: `bool`
`this.IsObjectWithoutMembers` Full Usage: `this.IsObjectWithoutMembers` Returns: `bool`	Returns: `bool`
`this.IsOnlyNullUndefinedToUnit` Full Usage: `this.IsOnlyNullUndefinedToUnit` Returns: `bool`	Returns: `bool`
`this.IsPolymorphicThisAsDeclaringType` Full Usage: `this.IsPolymorphicThisAsDeclaringType` Returns: `bool`	Returns: `bool`
`this.IsReferencedArityUnconfirmed` Full Usage: `this.IsReferencedArityUnconfirmed` Returns: `bool`	Returns: `bool`
`this.IsSelfReferenceThroughUnnamed` Full Usage: `this.IsSelfReferenceThroughUnnamed` Returns: `bool`	Returns: `bool`
`this.IsStringLiteralToString` Full Usage: `this.IsStringLiteralToString` Returns: `bool`	Returns: `bool`
`this.IsStringMappingToString` Full Usage: `this.IsStringMappingToString` Returns: `bool`	Returns: `bool`
`this.IsSymbolNoBinding` Full Usage: `this.IsSymbolNoBinding` Returns: `bool`	Returns: `bool`
`this.IsTemplateLiteralToString` Full Usage: `this.IsTemplateLiteralToString` Returns: `bool`	Returns: `bool`
`this.IsThisOutsideDeclaration` Full Usage: `this.IsThisOutsideDeclaration` Returns: `bool`	Returns: `bool`
`this.IsTupleArityNoForm` Full Usage: `this.IsTupleArityNoForm` Returns: `bool`	Returns: `bool`
`this.IsTupleRestToArray` Full Usage: `this.IsTupleRestToArray` Returns: `bool`	Returns: `bool`
`this.IsTypeFlagsNotMapped` Full Usage: `this.IsTypeFlagsNotMapped` Returns: `bool`	Returns: `bool`
`this.IsTypeNotResolved` Full Usage: `this.IsTypeNotResolved` Returns: `bool`	Returns: `bool`
`this.IsTypeParameterOutOfScope` Full Usage: `this.IsTypeParameterOutOfScope` Returns: `bool`	Returns: `bool`
`this.IsTypeParameterOutOfScopeToConstraint` Full Usage: `this.IsTypeParameterOutOfScopeToConstraint` Returns: `bool`	Returns: `bool`
`this.IsUnionTooWide` Full Usage: `this.IsUnionTooWide` Returns: `bool`	Returns: `bool`
`this.IsUnionWithObjArm` Full Usage: `this.IsUnionWithObjArm` Returns: `bool`	Returns: `bool`
`this.IsUniqueSymbolNoBinding` Full Usage: `this.IsUniqueSymbolNoBinding` Returns: `bool`	Returns: `bool`
`this.IsUnknownToObj` Full Usage: `this.IsUnknownToObj` Returns: `bool`	Returns: `bool`
`this.IsUnnamedBrandToPrimitive` Full Usage: `this.IsUnnamedBrandToPrimitive` Returns: `bool`	Returns: `bool`