API reference

Interface DescribeTextQuoteOptions

Hierarchy

  • DescribeTextQuoteOptions

Index

Properties

Optional maxWordLength

maxWordLength: number

When attempting to find a whitespace to make the prefix/suffix start/end (resp.) at a word boundary, give up after this number of characters.

Optional minimalContext

minimalContext: boolean

Keep prefix and suffix to the minimum that is necessary to disambiguate the quote. Use only if robustness against text variations is not required.

Optional minimumQuoteLength

minimumQuoteLength: number

Add prefix and suffix to quotes below this length, such that the total of prefix + exact + suffix is at least this length.