Skip to main content

Type Alias: TypeOrigin

type TypeOrigin = {
  datatypeName: IdentifierLike;
  moduleName: IdentifierLike;
  package: ObjectIdLike;
};

Stores the origin of a data type where it first appeared in the version chain. A data type is identified by the name of the module and the name of the struct/enum in combination.

BCS

The BCS serialized form for this type is defined by the following ABNF:

type-origin = identifier identifier object-id

Properties​

datatypeName​

datatypeName: IdentifierLike;

The name of the data type. Either refers to an enum or a struct identifier.

moduleName​

moduleName: IdentifierLike;

The name of the module the data type resides in.

package​

package: ObjectIdLike;

ID of the package, where the given type first appeared.