Documentation
Preparing search index...
@quatrain/okf-ingest-catalog
CatalogIngestionSummary
Interface CatalogIngestionSummary
Aggregated execution report for an ingested catalog.
interface
CatalogIngestionSummary
{
bookSlug
:
string
;
bookTitle
:
string
;
createdFiles
:
string
[]
;
masterIndexPath
:
string
;
totalChapters
:
number
;
totalDiagrams
:
number
;
totalEntries
:
number
;
totalTables
:
number
;
usage
:
OkfTokenUsage
;
}
Index
Properties
book
Slug
book
Title
created
Files
master
Index
Path
total
Chapters
total
Diagrams
total
Entries
total
Tables
usage
Properties
book
Slug
bookSlug
:
string
book
Title
bookTitle
:
string
created
Files
createdFiles
:
string
[]
master
Index
Path
masterIndexPath
:
string
total
Chapters
totalChapters
:
number
total
Diagrams
totalDiagrams
:
number
total
Entries
totalEntries
:
number
total
Tables
totalTables
:
number
usage
usage
:
OkfTokenUsage
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
book
Slug
book
Title
created
Files
master
Index
Path
total
Chapters
total
Diagrams
total
Entries
total
Tables
usage
Documentation
Loading...
Aggregated execution report for an ingested catalog.