Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Document

Interface that provides access to information about Document blocks. The Document block always forms the root of the tree and there is only one Document block per Textract response.

The Document block will have one Page block child for each page in the processed document.

Hierarchy

Index

Properties

blockType

blockType: Document

Constant indicating the type of Block. Can be used for type descrimination, see BlockType for more details.

metadata

Provides metadata regarding the processed document

Methods

children

hasChild

  • Determines whether or not the specified node is a child of this node.

    Parameters

    Returns boolean

    true if the item is a child of this node, false otherwise

parent

  • parent(): Block | undefined
  • Get the parent node of this node

    Returns Block | undefined

    the parent of this node or undefined if this is the root node

Generated using TypeDoc