module function · N/documentCapture
documentToText()
documentCapture.documentToText(options)
Extracts text content from a PDF file.
- Implementation
- Not started
- Design
- Open for proposals suggest how it should read
A
suitescript api
1documentCapture.documentToText({2 file: /* file.File, required */,3 timeout: /* number, optional */4});| Parameter | Type | Required | Description |
|---|---|---|---|
| options.file | file.File | required | The PDF file to extract content from. The specified file must be located in the NetSuite File Cabinet and be in PDF format. You can specify the file using its internal ID or the path to the file in the File Cabinet. For more information, see N/file Module . Encrypted files are not supported. |
| options.timeout | number | optional | The timeout period to wait for a response from the service. By default, the timeout period is 30,000 milliseconds (30 seconds). You can specify a longer timeout period, but you can't specify one that's shorter than 30,000 milliseconds. If you try to specify a shorter timeout period, the default value of 30,000 milliseconds is used instead. |
B
mynt syntax
No Mynt syntax yet.
Nothing in the language compiles to documentCapture.documentToText(options) today. How should it read?
C
community proposals
Competing syntax for documentToText, from GitHub Discussions. Select two or more to compare them side by side.
Loading proposals from GitHub…
D
suggest an alternative
Write the Mynt you wish you could write.
A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.
- Clarity. Does it say what happens, without ceremony?
- Consistency. Does it read like
load,saveandRef[field]? - Expressiveness. Does it cover the cases people actually write?
- Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?