跳到主要内容

Class: NotionReader

Notion pages are retrieved recursively and converted to Document objects. Notion Database can also be loaded, and the serialization method can be customized.

[Note] To use this reader, must be created the Notion integration must be created in advance Please refer to this document for details.

Implements

Constructors

constructor

new NotionReader(options)

Constructor for the NotionReader class

Parameters

NameTypeDescription
optionsNotionReaderOptionsConfiguration options for the reader

Defined in

packages/core/src/readers/NotionReader.ts:33

Properties

crawl

Private crawl: (rootPageId: string) => Promise<Pages>

Type declaration

▸ (rootPageId): Promise<Pages>

Parameters
NameType
rootPageIdstring
Returns

Promise<Pages>

Defined in

packages/core/src/readers/NotionReader.ts:27

Methods

loadData

loadData(rootPageId): Promise<Document<Metadata>[]>

Loads recursively Notion pages and converts them to an array of Document objects

Parameters

NameTypeDescription
rootPageIdstringThe root Notion page ID

Returns

Promise<Document<Metadata>[]>

A Promise that resolves to an array of Document objects

Implementation of

BaseReader.loadData

Defined in

packages/core/src/readers/NotionReader.ts:63


loadPages

loadPages(rootPageId): Promise<Pages>

Loads recursively the Notion page with the specified root page ID.

Parameters

NameTypeDescription
rootPageIdstringThe root Notion page ID

Returns

Promise<Pages>

A Promise that resolves to a Pages object(Convertible with the toDocuments method)

Defined in

packages/core/src/readers/NotionReader.ts:54


toDocuments

toDocuments(pages): Document<Metadata>[]

Converts Pages to an array of Document objects

Parameters

NameTypeDescription
pagesPagesThe Notion pages to convert (Return value of loadPages)

Returns

Document<Metadata>[]

An array of Document objects

Defined in

packages/core/src/readers/NotionReader.ts:42