prop

const prop: object

Defined in: src/helpers/property.helpers.ts:350

Factory functions for constructing page property values.

Type Declaration

checkbox

checkbox: (checked) => object

Create a checkbox property value.

Parameters

checked

boolean

Returns

object

checkbox

checkbox: boolean

Example

prop.checkbox(true)

date

date: (start, options?) => DateValue

Create a date property value.

Parameters

start

string | null

ISO 8601 date or datetime string.

options?

DateOptions

Optional end date and time zone.

Returns

DateValue

Example

prop.date('2025-01-15')
prop.date('2025-01-15', { end: '2025-01-20' })
prop.date('2025-01-15T09:00:00', { timeZone: 'America/New_York' })
prop.date(null) // clear the date

email

email: (value) => object

Create an email property value.

Parameters

value

string | null

Returns

object

email

email: string | null

Example

prop.email('user@example.com')
prop.email(null) // clear

files

files: (entries) => object

Create a files property value.

Parameters

entries

FileEntry[]

Returns

object

files

files: ExternalFileEntry[]

Example

prop.files([{ name: 'doc.pdf', url: 'https://example.com/doc.pdf' }])

multiSelect

multiSelect: (names) => object

Create a multi-select property value.

Parameters

names

string[]

Returns

object

multi_select

multi_select: object[]

Example

prop.multiSelect(['Tag1', 'Tag2'])

number

number: (value) => object

Create a number property value.

Parameters

value

number | null

Returns

object

number

number: number | null

Example

prop.number(42)
prop.number(null) // clear the value

people

people: (userIds) => object

Create a people property value from an array of user IDs.

Parameters

userIds

string[]

Returns

object

people

people: object[]

Example

prop.people(['user-id-1', 'user-id-2'])

phoneNumber

phoneNumber: (value) => object

Create a phone number property value.

Parameters

value

string | null

Returns

object

phone_number

phone_number: string | null

Example

prop.phoneNumber('+1-555-0100')
prop.phoneNumber(null) // clear

relation

relation: (pageIds) => object

Create a relation property value from an array of page IDs.

Parameters

pageIds

string[]

Returns

object

relation

relation: object[]

Example

prop.relation(['page-id-1', 'page-id-2'])

richText

richText: (text) => object = richTextProp

Create a rich text property value.

Parameters

text

RichTextInput

Returns

object

rich_text

rich_text: ({ annotations: { bold: boolean; code: boolean; color: "default" | "blue" | "blue_background" | "brown" | "brown_background" | "gray" | "gray_background" | "green" | "green_background" | "orange" | "orange_background" | "pink" | "pink_background" | "purple" | "purple_background" | "red" | "red_background" | "yellow" | "yellow_background"; italic: boolean; strikethrough: boolean; underline: boolean; }; href: string | null; plain_text: string; text: { content: string; link: { url: string; } | null; }; type: "text"; } | { annotations: { bold: boolean; code: boolean; color: "default" | "blue" | "blue_background" | "brown" | "brown_background" | "gray" | "gray_background" | "green" | "green_background" | "orange" | "orange_background" | "pink" | "pink_background" | "purple" | "purple_background" | "red" | "red_background" | "yellow" | "yellow_background"; italic: boolean; strikethrough: boolean; underline: boolean; }; href: string | null; mention: { database: { id: string; }; type: "database"; } | { date: { end: string | null; start: string; time_zone?: string | null; }; type: "date"; } | { link_preview: { url: string; }; type: "link_preview"; } | { page: { id: string; }; type: "page"; } | { template_mention: { template_mention_date: … | …; type: "template_mention_date"; } | { template_mention_user: "me"; type: "template_mention_user"; }; type: "template_mention"; } | { type: "user"; user: { avatar_url?: … | … | …; id: string; name?: … | …; object: "user"; person: { email: …; email_verified?: …; }; type: "person"; } | { avatar_url?: … | … | …; bot: { owner: …; workspace_id?: …; workspace_limits?: …; workspace_name?: …; }; id: string; name?: … | …; object: "user"; type: "bot"; } | { id: string; object: "user"; }; }; plain_text: string; type: "mention"; } | { annotations: { bold: boolean; code: boolean; color: "default" | "blue" | "blue_background" | "brown" | "brown_background" | "gray" | "gray_background" | "green" | "green_background" | "orange" | "orange_background" | "pink" | "pink_background" | "purple" | "purple_background" | "red" | "red_background" | "yellow" | "yellow_background"; italic: boolean; strikethrough: boolean; underline: boolean; }; equation: { expression: string; }; href: string | null; plain_text: string; type: "equation"; })[]

Example

prop.richText('Some notes')
prop.richText(richText('Formatted').italic())

select

select: (name) => object

Create a select property value.

Parameters

name

string | null

Returns

object

select

select: { name: string; } | null

Example

prop.select('Option A')
prop.select(null) // clear the selection

status

status: (name) => object

Create a status property value.

Parameters

name

string | null

Returns

object

status

status: { name: string; } | null

Example

prop.status('In Progress')
prop.status(null) // clear the status

title

title: (text) => object

Create a title property value.

Parameters

text

RichTextInput

Returns

object

title

title: ({ annotations: { bold: boolean; code: boolean; color: "default" | "blue" | "blue_background" | "brown" | "brown_background" | "gray" | "gray_background" | "green" | "green_background" | "orange" | "orange_background" | "pink" | "pink_background" | "purple" | "purple_background" | "red" | "red_background" | "yellow" | "yellow_background"; italic: boolean; strikethrough: boolean; underline: boolean; }; href: string | null; plain_text: string; text: { content: string; link: { url: string; } | null; }; type: "text"; } | { annotations: { bold: boolean; code: boolean; color: "default" | "blue" | "blue_background" | "brown" | "brown_background" | "gray" | "gray_background" | "green" | "green_background" | "orange" | "orange_background" | "pink" | "pink_background" | "purple" | "purple_background" | "red" | "red_background" | "yellow" | "yellow_background"; italic: boolean; strikethrough: boolean; underline: boolean; }; href: string | null; mention: { database: { id: string; }; type: "database"; } | { date: { end: string | null; start: string; time_zone?: string | null; }; type: "date"; } | { link_preview: { url: string; }; type: "link_preview"; } | { page: { id: string; }; type: "page"; } | { template_mention: { template_mention_date: … | …; type: "template_mention_date"; } | { template_mention_user: "me"; type: "template_mention_user"; }; type: "template_mention"; } | { type: "user"; user: { avatar_url?: … | … | …; id: string; name?: … | …; object: "user"; person: { email: …; email_verified?: …; }; type: "person"; } | { avatar_url?: … | … | …; bot: { owner: …; workspace_id?: …; workspace_limits?: …; workspace_name?: …; }; id: string; name?: … | …; object: "user"; type: "bot"; } | { id: string; object: "user"; }; }; plain_text: string; type: "mention"; } | { annotations: { bold: boolean; code: boolean; color: "default" | "blue" | "blue_background" | "brown" | "brown_background" | "gray" | "gray_background" | "green" | "green_background" | "orange" | "orange_background" | "pink" | "pink_background" | "purple" | "purple_background" | "red" | "red_background" | "yellow" | "yellow_background"; italic: boolean; strikethrough: boolean; underline: boolean; }; equation: { expression: string; }; href: string | null; plain_text: string; type: "equation"; })[]

Example

prop.title('My Page')
prop.title(richText('Bold Title').bold())

url

url: (value) => object

Create a URL property value.

Parameters

value

string | null

Returns

object

url

url: string | null

Example

prop.url('https://example.com')
prop.url(null) // clear the URL

verification

verification: (state, date?) => VerificationValue

Create a verification property value.

Parameters

state

"verified" | "unverified"

date?

VerificationDateOptions

Returns

VerificationValue

Example

prop.verification('verified')
prop.verification('verified', { start: '2025-01-15' })
prop.verification('unverified')

Example

import { prop, richText } from '@visus-io/notion-sdk-ts';

notion.pages.create({
  parent: { database_id: 'db-id' },
  properties: {
    Name: prop.title('My Task'),
    Status: prop.status('In Progress'),
    Priority: prop.select('High'),
    'Due Date': prop.date('2025-02-01'),
    Score: prop.number(95),
    Done: prop.checkbox(false),
    Tags: prop.multiSelect(['urgent', 'frontend']),
    Assignee: prop.people(['user-id']),
    Notes: prop.richText(richText('Important').bold()),
  },
});