Skip to main content

ObjectRead

@iota/iota-sdk


@iota/iota-sdk / client / ObjectRead

Type Alias: ObjectRead

ObjectRead = { details: IotaObjectData; status: "VersionFound"; } | { details: string; status: "ObjectNotExists"; } | { details: IotaObjectRef; status: "ObjectDeleted"; } | { details: [string, string]; status: "VersionNotFound"; } | { details: { asked_version: string; latest_version: string; object_id: string; }; status: "VersionTooHigh"; }

Defined in: sdk/typescript/src/client/types/generated.ts:1264

Union Members​

Type Literal​

{ details: IotaObjectData; status: "VersionFound"; }

The object exists and is found with this version


Type Literal​

{ details: string; status: "ObjectNotExists"; }

The object does not exist


Type Literal​

{ details: IotaObjectRef; status: "ObjectDeleted"; }

The object is found to be deleted with this version


Type Literal​

{ details: [string, string]; status: "VersionNotFound"; }

The object exists but not found with this version


Type Literal​

{ details: { asked_version: string; latest_version: string; object_id: string; }; status: "VersionTooHigh"; }

The asked object version is higher than the latest