Skip to main content

Notebook

Datalayer Core

Datalayer Core / Notebook

Class: Notebook

Defined in: src/models/NotebookDTO.ts:67

Notebook domain model that extends the base Item class. Provides notebook-specific functionality for managing Jupyter notebooks.

Example​

const notebook = await sdk.createNotebook(formData);
const kernelSpec = await notebook.getKernelSpec();

Extends​

  • Item<NotebookData>

Constructors​

Constructor​

new Notebook(data, sdk): NotebookDTO

Defined in: src/models/NotebookDTO.ts:74

Create a Notebook instance.

Parameters​

data​

NotebookData

Notebook data from API

sdk​

DatalayerClient

SDK instance

Returns​

NotebookDTO

Overrides​

Item.constructor

Properties​

_data​

protected _data: NotebookData

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

Inherited from​

Item._data

Accessors​

content​

Get Signature​

get content(): any

Defined in: src/models/NotebookDTO.ts:100

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/NotebookDTO.ts:174

Description of the notebook.

Returns​

string

extension​

Get Signature​

get extension(): string

Defined in: src/models/NotebookDTO.ts:180

Get the notebook 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

kernelSpec​

Get Signature​

get kernelSpec(): any

Defined in: src/models/NotebookDTO.ts:168

Kernel specification (cached).

Returns​

any

metadata​

Get Signature​

get metadata(): Record<string, any>

Defined in: src/models/NotebookDTO.ts:162

Notebook metadata.

Returns​

Record<string, any>

name​

Get Signature​

get name(): string

Defined in: src/models/NotebookDTO.ts:89

The cached name of the notebook.

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

path​

Get Signature​

get path(): string

Defined in: src/models/NotebookDTO.ts:150

File path within the space.

Returns​

string

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/NotebookDTO.ts:83

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

version​

Get Signature​

get version(): number

Defined in: src/models/NotebookDTO.ts:156

Version number.

Returns​

number

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 SDK 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​

NotebookData

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/NotebookDTO.ts:113

Get the current name from API.

Returns​

Promise<string>

Overrides​

Item.getName

getUpdatedAt()​

getUpdatedAt(): Promise<Date>

Defined in: src/models/NotebookDTO.ts:120

Get when the notebook was last updated from API.

Returns​

Promise<Date>

Overrides​

Item.getUpdatedAt

rawData()​

rawData(): NotebookData

Defined in: src/models/NotebookDTO.ts:214

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

Returns​

NotebookData

Raw notebook data from API

Overrides​

Item.rawData

toJSON()​

toJSON(): NotebookJSON

Defined in: src/models/NotebookDTO.ts:193

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

Returns​

NotebookJSON

Core notebook 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<NotebookDTO>

Defined in: src/models/NotebookDTO.ts:131

Update the notebook.

Parameters​

name?​

string

description?​

string

Returns​

Promise<NotebookDTO>

Overrides​

Item.update