Skip to main content

InternalTypes Namespace

Interfaces​

InterfaceAlertsModifiersDescription
DefaultProviderSystemsealedProvides a default value for a field.

Types​

TypeAliasAlertsDescription
_InlineTrickSystemUse for trick to "inline" generic types.
ApplyKindSystemSuitable for output. For input must error on side of excluding undefined instead.
ApplyKindInputSystemSuitable for input.
ExtractItemTypeSystemGet the Item type from a LazyItem<Item>.
FieldHasDefaultSystemType utility for determining if an implicit field schema is known to have a default value.
FlattenKeysSystemReturn a type thats equivalent to the input, but with different IntelliSense. This tends to convert unions and intersections into objects.
FlexListSystemA flexible way to list values. Each item in the list can either be an "eager" **value** or a "lazy" **function that returns a value** (the latter allows cyclic references to work).
FlexListToUnionSystemNormalize FlexList type to a union.
InsertableObjectFromSchemaRecordSystem

Helper used to produce types for:

  1. Insertable content which can be used to construct an object node. In this case, only own properties are considered. This reduces the risk of incorrectly interpreting data at the cost of occasionally requiring users to convert data into a compatible format.
  1. Insertable content which is an unhydrated object node.
  1. Union of 1 and 2.
NodeBuilderDataSystemGiven a node's schema, return the corresponding object from which the node could be built.
ScopedSchemaNameSystemThe name of a schema produced by SchemaFactory, including its optional scope prefix.

Variables​

VariableAlertsModifiersTypeDescription
typeNameSymbolSystemreadonlyunique symbolAn internal brand to improve compiler performance. For more information about the type, use Tree.schema(theNode) instead.

Variable Details​

typeNameSymbol​

An internal brand to improve compiler performance. For more information about the type, use Tree.schema(theNode) instead.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature​

typeNameSymbol: unique symbol

Type: unique symbol

Remarks​

Tree.is and Tree.schema provide a superset of this information in more friendly ways.