Skip to main content

DomainRow

Defined in: js-api/src/entities/domain.ts:70

A single row of a DomainTable. Its semantic type is the row's entity type name, '<schema>.<table>' — the string an ObjectHandler keys on to override rendering per table (see Grit's grit.issue handler).

Constructors​

Constructor​

new DomainRow(dart): DomainRow

Defined in: js-api/src/entities/domain.ts:73

Parameters​

ParameterType
dartany

Returns​

DomainRow

Properties​

PropertyModifierTypeDefined in
dartpublicanyjs-api/src/entities/domain.ts:71

Accessors​

authorId​

Get Signature​

get authorId(): string

Defined in: js-api/src/entities/domain.ts:104

Id of the user who last authored the row.

Returns​

string


createdOn​

Get Signature​

get createdOn(): Dayjs | null

Defined in: js-api/src/entities/domain.ts:107

Creation instant (dayjs; null when the wire value is absent).

Returns​

Dayjs | null


displayName​

Get Signature​

get displayName(): string

Defined in: js-api/src/entities/domain.ts:92

Human-facing name: the table's isName column value, falling back to semValue, then id. Display identity only — addressing (handles, deep links) stays on semValue/id.

Returns​

string


id​

Get Signature​

get id(): string

Defined in: js-api/src/entities/domain.ts:98

Row id (GUID) — the storage and security identity.

Returns​

string


schemaName​

Get Signature​

get schemaName(): string

Defined in: js-api/src/entities/domain.ts:78

Domain schema name (also the physical PostgreSQL schema).

Returns​

string


semValue​

Get Signature​

get semValue(): string

Defined in: js-api/src/entities/domain.ts:87

Display/addressing identity: business-key values joined by '-', or the row id.

Returns​

string


tableName​

Get Signature​

get tableName(): string

Defined in: js-api/src/entities/domain.ts:81

Table name within the schema.

Returns​

string


typeName​

Get Signature​

get typeName(): string

Defined in: js-api/src/entities/domain.ts:84

Row entity type and semantic type: '<schema>.<table>'.

Returns​

string


updatedOn​

Get Signature​

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/domain.ts:113

Last-update instant (dayjs; null when the wire value is absent).

Returns​

Dayjs | null


values​

Get Signature​

get values(): object

Defined in: js-api/src/entities/domain.ts:95

Raw row values keyed by wire column name (declared columns, jsonb keys, system fields).

Returns​

object


version​

Get Signature​

get version(): number

Defined in: js-api/src/entities/domain.ts:101

Optimistic-concurrency version.

Returns​

number

Methods​

toString()​

toString(): string

Defined in: js-api/src/entities/domain.ts:118

Returns​

string