@heromatic/notion-helper
v1.0.1
Published
A TypeScript helper library for Notion API operations
Readme
@your-org/notion-helper
A TypeScript helper library for Notion API operations, providing simplified interfaces for database queries, filtering, and property management.
Features
- NotionDatabaseClient: Simplified database operations
- NotionFilterBuilder: Easy-to-use filter construction
- NotionPropertyBuilder: Property management utilities
- Type-safe: Full TypeScript support with proper type definitions
- Lightweight: Minimal dependencies
Installation
npm install @your-org/notion-helper @notionhq/client
# or
yarn add @your-org/notion-helper @notionhq/clientUsage
import { NotionDatabaseClient, NotionFilterBuilder } from '@your-org/notion-helper';
// Initialize the client
const dbClient = new NotionDatabaseClient('your-database-id');
// Build filters
const filter = new NotionFilterBuilder()
.addTextFilter('Name', 'contains', 'example')
.build();
// Query database
const results = await dbClient.query({ filter });API Reference
NotionDatabaseClient
Main class for database operations.
NotionFilterBuilder
Helper class for building Notion database filters.
NotionPropertyBuilder
Utility class for managing Notion properties.
Requirements
- Node.js >= 14.0.0
- @notionhq/client >= 2.0.0
License
MIT
