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
| Name |
|---|
|
|
Hierarchy
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
| Name | Type |
|---|---|
|
|
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
| Name |
|---|
|
Parameters
| Name | Type |
|---|---|
|
|
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
| Name | Type | Description |
|---|---|---|
|
| object to type check |
Returns
boolean
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
|
Parameters
| Name | Type | Description |
|---|---|---|
|
| UUID to unserialize |
Returns
Identifiers
Defined in
Last updated