Skip to content

feat: add maxCharacters param for highlights, deprecate numSentences/highlightsPerUrl #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LiamHz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add maxCharacters param for highlights, deprecate numSentences/highlightsPerUrl #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,12 +170,16 @@ export type TextContentsOptions = {
* to your initial query, and may vary in quantity and length.
* @typedef {Object} HighlightsContentsOptions
* @property {string} [query] - The query string to use for highlights search.
* @property {number} [numSentences] - The number of sentences to return for each highlight.
* @property {number} [highlightsPerUrl] - The number of highlights to return for each URL.
* @property {number} [maxCharacters] - Maximum total characters across all highlights per URL. Characters are distributed across multiple non-contiguous highlights (default 5). If the full page is shorter than maxCharacters, the entire page is returned. Default is 2000.
* @property {number} [numSentences] - Deprecated: use maxCharacters instead. The number of sentences to return for each highlight.
* @property {number} [highlightsPerUrl] - Deprecated: use maxCharacters instead. The number of highlights to return for each URL.
*/
export type HighlightsContentsOptions = {
query?: string;
maxCharacters?: number;
/** @deprecated Use maxCharacters instead */
numSentences?: number;
/** @deprecated Use maxCharacters instead */
highlightsPerUrl?: number;
};

Expand Down