LexicalDTO

Datalayer Core

---

Datalayer Core / LexicalDTO

Class: LexicalDTO

Defined in: src/models/LexicalDTO.ts:139

Lexical domain model that extends the base Item class. Provides lexical document functionality for managing rich text documents.

Example

const lexical = await client.createLexical(formData);
await lexical.update({ name: 'Updated Documentation' });

Extends

• Item<LexicalData>

Constructors

Constructor

new LexicalDTO(data, client): LexicalDTO

Defined in: src/models/LexicalDTO.ts:146

Create a Lexical instance.

Parameters

data

LexicalData

Lexical data from API

client

DatalayerClient

Client instance

Returns

LexicalDTO

Overrides

Item.constructor

Properties

_data

protected _data: LexicalData

Defined in: src/models/ItemDTO.ts:23

Inherited from

Item._data

Accessors

content

Get Signature

get content(): any

Defined in: src/models/LexicalDTO.ts:182

The cached content.

Returns

any

Overrides

Item.content

---

createdAt

Get Signature

get createdAt(): Date

Defined in: src/models/ItemDTO.ts:105

When the item was created.

Returns

Date

Inherited from

Item.createdAt

---

description

Get Signature

get description(): string

Defined in: src/models/LexicalDTO.ts:195

Description of the lexical document.

Returns

string

---

extension

Get Signature

get extension(): string

Defined in: src/models/LexicalDTO.ts:201

Get the document extension.

Returns

string

---

id

Get Signature

get id(): string

Defined in: src/models/ItemDTO.ts:63

Item ID.

Returns

string

Inherited from

Item.id

---

isDeleted

Get Signature

get isDeleted(): boolean

Defined in: src/models/ItemDTO.ts:42

Check if this item has been deleted.

Returns

boolean

Inherited from

Item.isDeleted

---

name

Get Signature

get name(): string

Defined in: src/models/LexicalDTO.ts:161

The cached name of the document.

Returns

string

Overrides

Item.name

---

ownerId

Get Signature

get ownerId(): string

Defined in: src/models/ItemDTO.ts:97

Owner user ID.

Returns

string

Inherited from

Item.ownerId

---

spaceId

Get Signature

get spaceId(): string

Defined in: src/models/ItemDTO.ts:75

Parent space ID.

Returns

string

Inherited from

Item.spaceId

---

type

Get Signature

get type(): string

Defined in: src/models/LexicalDTO.ts:155

Document type identifier.

Returns

string

Overrides

Item.type

---

uid

Get Signature

get uid(): string

Defined in: src/models/ItemDTO.ts:69

Unique identifier for the item.

Returns

string

Inherited from

Item.uid

---

updatedAt

Get Signature

get updatedAt(): Date

Defined in: src/models/ItemDTO.ts:118

The cached update time.

Returns

Date

Inherited from

Item.updatedAt

Methods

_checkDeleted()

protected _checkDeleted(): void

Defined in: src/models/ItemDTO.ts:50

Check if this item has been deleted and throw error if so.

Returns

void

Throws

Error if deleted

Inherited from

Item._checkDeleted

---

_getSpacerRunUrl()

protected _getSpacerRunUrl(): string

Defined in: src/models/ItemDTO.ts:251

Get spacer API URL for API calls.

Returns

string

Inherited from

Item._getSpacerRunUrl

---

_getToken()

protected _getToken(): string

Defined in: src/models/ItemDTO.ts:246

Get Client token for API calls.

Returns

string

Inherited from

Item._getToken

---

_updateData()

protected _updateData(newData): void

Defined in: src/models/ItemDTO.ts:256

Update internal data after API call.

Parameters

newData

LexicalData

Returns

void

Inherited from

Item._updateData

---

delete()

delete(): Promise<void>

Defined in: src/models/ItemDTO.ts:163

Delete this item permanently. After deletion, all subsequent method calls will throw errors.

Returns

Promise<void>

Inherited from

Item.delete

---

getContent()

getContent(): Promise<any>

Defined in: src/models/ItemDTO.ts:172

Get the document content from API.

Returns

Promise<any>

Inherited from

Item.getContent

---

getName()

getName(): Promise<string>

Defined in: src/models/LexicalDTO.ts:167

Get the current name of the document from API.

Returns

Promise<string>

Overrides

Item.getName

---

getUpdatedAt()

getUpdatedAt(): Promise<Date>

Defined in: src/models/LexicalDTO.ts:208

Get when the document was last updated from API.

Returns

Promise<Date>

Overrides

Item.getUpdatedAt

---

rawData()

rawData(): LexicalData

Defined in: src/models/LexicalDTO.ts:288

Get the raw lexical data exactly as received from the API. This preserves the original snake_case naming from the API response.

Returns

LexicalData

Raw lexical data from API

Overrides

Item.rawData

---

toJSON()

toJSON(): LexicalJSON

Defined in: src/models/LexicalDTO.ts:265

Get lexical document data in camelCase format. Returns only the core fields that consumers need. This provides a stable interface regardless of API changes.

Returns

LexicalJSON

Core lexical data with camelCase properties

Overrides

Item.toJSON

---

toString()

toString(): string

Defined in: src/models/ItemDTO.ts:235

String representation of the item.

Returns

string

Inherited from

Item.toString

---

update()

update(name?, description?): Promise<LexicalDTO>

Defined in: src/models/LexicalDTO.ts:239

Update the document.

Parameters

name?

string

description?

string

Returns

Promise<LexicalDTO>

Overrides

Item.update