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
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
Abstract exists
Abstract exists▸ exists(): Promise‹boolean›
Defined in src/api/entities/Entity.ts:68
Determine whether this Entity exists on chain
Returns: Promise‹boolean›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Defined in src/api/entities/Entity.ts:61
Determine whether this Entity is the same as another one
Parameters:
entity
Returns: boolean
Abstract toHuman
Abstract toHuman▸ toHuman(): HumanReadable
Defined in src/api/entities/Entity.ts:73
Returns Entity data in a human readable (JSON) format
Returns: HumanReadable
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers
Parameters:
identifiers
Identifiers
Returns: string
Static isUniqueIdentifiers
Static isUniqueIdentifiers▸ isUniqueIdentifiers(identifiers: unknown): boolean
Defined in src/api/entities/Entity.ts:42
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
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated