forked from mwilliamson/mammoth.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
79 lines (61 loc) · 1.49 KB
/
index.d.ts
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
interface Mammoth {
convertToHtml: (input: Input, options?: Options) => Promise<Result>;
extractRawText: (input: Input) => Promise<Result>;
embedStyleMap: (input: Input, styleMap: string) => Promise<{toBuffer: () => Buffer}>;
images: Images;
}
type Input = NodeJsInput | BrowserInput;
type NodeJsInput = PathInput | BufferInput;
interface PathInput {
path: string;
}
interface BufferInput {
buffer: Buffer;
}
type BrowserInput = ArrayBufferInput;
interface ArrayBufferInput {
arrayBuffer: ArrayBuffer;
}
interface Options {
styleMap?: string | Array<string>;
includeEmbeddedStyleMap?: boolean;
includeDefaultStyleMap?: boolean;
convertImage?: ImageConverter;
ignoreEmptyParagraphs?: boolean;
idPrefix?: string;
transformDocument?: (element: any) => any;
}
interface ImageConverter {
__mammothBrand: "ImageConverter";
}
interface Image {
contentType: string;
read: ImageRead;
}
interface ImageRead {
(): Promise<Buffer>;
(encoding: string): Promise<string>;
}
interface ImageAttributes {
src: string;
}
interface Images {
dataUri: ImageConverter;
imgElement: (f: (image: Image) => Promise<ImageAttributes>) => ImageConverter;
}
interface Result {
value: string;
messages: Array<Message>;
}
type Message = Warning | Error;
interface Warning {
type: "warning";
message: string;
}
interface Error {
type: "error";
message: string;
error: unknown;
}
declare const mammoth: Mammoth;
export = mammoth;