api_entities_Entity.Entity
@polymeshassociation/polymesh-sdk / Modules / api/entities/Entity / Entity
Class: Entity<UniqueIdentifiers, HumanReadable>
api/entities/Entity.Entity
Represents an object or resource in the Polymesh Ecosystem with its own set of properties and functionality
Type parameters
UniqueIdentifiers
HumanReadable
Hierarchy
Entity↳
Account↳
Asset↳
Checkpoint↳
Identity↳
Instruction↳
Offering↳
PermissionGroup↳
Portfolio↳
Subsidy↳
Venue
Table of contents
Properties
Methods
Properties
uuid
• uuid: string
Defined in
Methods
exists
â–¸ Abstract exists(): Promise<boolean>
Determine whether this Entity exists on chain
Returns
Promise<boolean>
Defined in
isEqual
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Entity<unknown, unknown>
Returns
boolean
Defined in
toHuman
â–¸ Abstract toHuman(): HumanReadable
Returns Entity data in a human readable (JSON) format
Returns
HumanReadable
Defined in
generateUuid
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Defined in
isUniqueIdentifiers
â–¸ Static isUniqueIdentifiers(identifiers): boolean
Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden
Parameters
identifiers
unknown
object to type check
Returns
boolean
Defined in
unserialize
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Defined in
Last updated