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

Hierarchy

Table of contents

Properties

Methods

Properties

uuid

uuid: string

Defined in

api/entities/Entity.ts:46

Methods

exists

Abstract exists(): Promise<boolean>

Determine whether this Entity exists on chain

Returns

Promise<boolean>

Defined in

api/entities/Entity.ts:68


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Returns

boolean

Defined in

api/entities/Entity.ts:61


toHuman

Abstract toHuman(): HumanReadable

Returns Entity data in a human readable (JSON) format

Returns

HumanReadable

Defined in

api/entities/Entity.ts:73


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Parameters

Returns

string

Defined in

api/entities/Entity.ts:14


isUniqueIdentifiers

Static isUniqueIdentifiers(identifiers): boolean

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

Parameters

Returns

boolean

Defined in

api/entities/Entity.ts:42


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Parameters

Returns

Identifiers

Defined in

api/entities/Entity.ts:23

Last updated