Entity
Represents an object or resource in the Polymesh Ecosystem with its own set of properties and functionality

Type parameters

UniqueIdentifiers
HumanReadable

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

uuid

uuid: string

Methods

Abstract exists

exists(): Promise‹boolean›
Determine whether this Entity exists on chain
Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

Abstract toJson

toJson(): HumanReadable
Returns Entity data in a human readable (JSON) format
Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static isUniqueIdentifiers

isUniqueIdentifiers(identifiers: unknown): boolean
Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden
Parameters:
Name
Type
Description
identifiers
unknown
object to type check
Returns: boolean

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago