parent

const parent: object

Defined in: src/helpers/parent.helpers.ts:107

Helpers for constructing parent objects for Notion API create operations.

Type Declaration

block

block: (blockId) => object = blockParent

Create a block parent object for comments on blocks.

Parameters

blockId

string

Returns

object

block_id

block_id: string

Example

parent.block('block-id')

database

database: (databaseId) => object

Create a database parent object.

Parameters

databaseId

string

Returns

object

database_id

database_id: string

Example

parent.database('database-id')

dataSource

dataSource: (dataSourceId, databaseId) => object

Create a data source parent object. A page with a data source parent needs both data_source_id and database_id.

Parameters

dataSourceId

string

databaseId

string

Returns

object

data_source_id

data_source_id: string

database_id

database_id: string

Example

// Get database info first
const db = await notion.databases.retrieve('database-id');
const dsId = db.dataSources[0].id;

// Create page with data source parent
parent.dataSource(dsId, db.id)

page

page: (pageId) => object

Create a page parent object.

Parameters

pageId

string

Returns

object

page_id

page_id: string

Example

parent.page('page-id')

workspace

workspace: () => object

Create a workspace parent object.

Returns

object

workspace

workspace: true

Example

parent.workspace()

Example

import { parent } from '@visus-io/notion-sdk-ts';

// Create a page in a database
notion.pages.create({
  parent: parent.database('db-id'),
  properties: { ... },
});

// Create a database under a page
notion.databases.create({
  parent: parent.page('page-id'),
  properties: { ... },
});

// Create a comment on a block
notion.comments.create({
  parent: parent.block('block-id'),
  rich_text: [...],
});