filter
constfilter:object
Defined in: src/helpers/filter.helpers.ts:368
Chainable database filter builders for Notion’s query API.
Type Declaration
Section titled “Type Declaration”and: (…
conditions) =>FilterCondition
Combine filters with AND logic.
Parameters
Section titled “Parameters”conditions
Section titled “conditions”…FilterCondition[]
Returns
Section titled “Returns”FilterCondition
Example
Section titled “Example”filter.and( filter.status('Status').equals('Active'), filter.select('Priority').equals('High'),)checkbox
Section titled “checkbox”checkbox: (
property) =>CheckboxFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”CheckboxFilter
createdTime
Section titled “createdTime”createdTime: () =>
DateFilter
Returns
Section titled “Returns”DateFilter
date: (
property) =>DateFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”DateFilter
email: (
property) =>TextFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”TextFilter
files: (
property) =>FilesFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”FilesFilter
formula
Section titled “formula”formula: (
property) =>FormulaFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”FormulaFilter
lastEditedTime
Section titled “lastEditedTime”lastEditedTime: () =>
DateFilter
Returns
Section titled “Returns”DateFilter
multiSelect
Section titled “multiSelect”multiSelect: (
property) =>MultiSelectFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”MultiSelectFilter
number
Section titled “number”number: (
property) =>NumberFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”NumberFilter
or: (…
conditions) =>FilterCondition
Combine filters with OR logic.
Parameters
Section titled “Parameters”conditions
Section titled “conditions”…FilterCondition[]
Returns
Section titled “Returns”FilterCondition
Example
Section titled “Example”filter.or( filter.date('Due').before('2025-02-01'), filter.date('Due').isEmpty(),)people
Section titled “people”people: (
property) =>PeopleFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”PeopleFilter
phoneNumber
Section titled “phoneNumber”phoneNumber: (
property) =>TextFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”TextFilter
relation
Section titled “relation”relation: (
property) =>RelationFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”RelationFilter
select
Section titled “select”select: (
property) =>SelectFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”SelectFilter
status
Section titled “status”status: (
property) =>StatusFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”StatusFilter
text: (
property) =>TextFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”TextFilter
title: (
property) =>TextFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”TextFilter
url: (
property) =>TextFilter
Parameters
Section titled “Parameters”property
Section titled “property”string
Returns
Section titled “Returns”TextFilter
Example
Section titled “Example”import { filter } from '@visus-io/notion-sdk-ts';
notion.databases.query('db-id', { filter: filter.and( filter.status('Status').equals('Active'), filter.number('Score').greaterThan(80), filter.or( filter.date('Due Date').before('2025-02-01'), filter.date('Due Date').isEmpty(), ), ),});