ReadableField TypeAlias

Content which could be read from a field within a tree.

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

export type ReadableField<TSchema extends ImplicitFieldSchema | UnsafeUnknownSchema> = TreeFieldFromImplicitField<ReadSchema<TSchema>>;

Type Parameters

Parameter	Constraint	Description
TSchema	ImplicitFieldSchema | UnsafeUnknownSchema

Remarks

Extended version of TreeFieldFromImplicitField that also allows UnsafeUnknownSchema. Since reading from fields with non-exact schema is still safe, this is only useful (compared to TreeFieldFromImplicitField) when the schema is also used as input and thus allows UnsafeUnknownSchema for use