doc-extract/doc-extract.d.ts at main · alexstep/doc-extract · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
export type DocExtractFormat =
  | 'pdf'
  | 'docx'
  | 'docm'
  | 'xlsx'
  | 'xls'
  | 'ods'
  | 'pptx'
  | 'pptm'
  | 'epub'
  | 'rtf'
  | 'odt'
  | 'fb2'
  | 'ics'
  | 'ifb'
  | 'ical'
  | 'json'
  | 'jsonl'
  | 'ndjson'
  | 'vcf'
  | 'vcard'
  | 'csv'
  | 'tsv'
  | 'html'
  | 'htm'
  | 'xhtml'
  | 'xml'
  | 'txt'
  | 'md'
  | 'markdown'
  | 'log'
  | 'pkpass'

export type UnknownPolicy = 'reject' | 'text-if-likely' | 'text-lossy'

export interface DocExtractOptions {
  maxConcurrent?: number
  maxFileSizeMB?: number
  inMemoryThresholdMB?: number
  tempDir?: string
  debug?: boolean
}

export interface ExtractCallOptions {
  format?: DocExtractFormat
  unknown?: UnknownPolicy
  maxFileSizeMB?: number
  inMemoryThresholdMB?: number
  tempDir?: string
  debug?: boolean
}

export interface PkPassResult {
  pass: Record<string, unknown>
  localization?: string
  stripImage?: string
}

declare class DocExtract {
  maxFileSizeMB?: number
  maxConcurrent?: number
  inMemoryThresholdMB?: number
  tempDir?: string
  debug?: boolean

  constructor(options?: DocExtractOptions)

  extractText(
    input: Buffer | string,
    formatOrOptions?: DocExtractFormat | ExtractCallOptions,
  ): Promise<string>
  parsePkPass(
    input: Buffer | string,
    options?: Pick<ExtractCallOptions, 'maxFileSizeMB' | 'inMemoryThresholdMB' | 'tempDir'>,
  ): Promise<PkPassResult | null>

  static setMaxConcurrent(n: number): void
  static setMaxFilesizeMB(n: number): void
  static setInMemoryThresholdMB(n: number): void
  static setMaxWorkingSetMB(n: number): void
  static setTempDir(dir: string | undefined): void
  static extractText(
    input: Buffer | string,
    formatOrOptions?: DocExtractFormat | ExtractCallOptions,
  ): Promise<string>
  static parsePkPass(
    input: Buffer | string,
    options?: Pick<ExtractCallOptions, 'maxFileSizeMB' | 'inMemoryThresholdMB' | 'tempDir'>,
  ): Promise<PkPassResult | null>
}

export default DocExtract