Skip to main content

JavaScript SDK API Reference / Records / RecordResult

Interface: RecordResult

Defined in: record/getRecord.ts:44

Result returned by getRecord and by defined entries from getMultipleRecords.

Example

{
record: Record.Url,
retrievedRecord: retrievedUrlRecord,
verified: {
staleness: true,
roa: true,
},
deserializedContent: "https://example.com",
}

Properties

deserializedContent?

optional deserializedContent?: string

Defined in: record/getRecord.ts:66

Record payload decoded to its display string. Present only when the caller sets options.deserialize to true.


record

record: Record

Defined in: record/getRecord.ts:46

Record type requested by the caller.


retrievedRecord

retrievedRecord: RetrievedRecord

Defined in: record/getRecord.ts:49

Raw V2 record account, including its header and encoded payload.


verified

verified: object

Defined in: record/getRecord.ts:52

Verification results for the current effective domain owner and record verifier.

roa?

optional roa?: boolean

Whether the Right of Association identifier matches the expected self-signed or guardian verifier and the header declares the required validation scheme. Omitted when the record type has no configured verifier.

staleness

staleness: boolean

Whether the staleness identifier and validation mode match the domain owner.