From b1e2c8fd5cb5dfa46bc440a12eafaf56cd844b1c Mon Sep 17 00:00:00 2001 From: Philipp Tanlak Date: Mon, 24 Nov 2025 20:54:57 +0100 Subject: Docs --- content/docs/configuration/output.md | 47 ++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 content/docs/configuration/output.md (limited to 'content/docs/configuration/output.md') diff --git a/content/docs/configuration/output.md b/content/docs/configuration/output.md new file mode 100644 index 0000000..2470865 --- /dev/null +++ b/content/docs/configuration/output.md @@ -0,0 +1,47 @@ +--- +title: 'Output File and Format' +weight: 10 +--- + +The output file and format are specified in the configuration object of your scraping script. They determine where the scraped data will be saved and in what format. + +## Output File + +The output file is the file where the scraped data will be saved. If not specified, the data will be printed to the standard output (stdout). + +```javascript {filename="Configuration"} +export const config = { + output: { + // Specify the output file. + file: "results.json", + }, +}; +``` + +In the above example, the scraped data will be saved in a file named `results.json`. + +## Output Format + +The output format is the format in which the scraped data will be saved. The options are `json` and `ndjson`. + +```javascript {filename="Configuration"} +export const config = { + output: { + // Specify the output format. + format: "json", + }, +}; +``` + +In the above example, the scraped data will be saved in JSON format. + +```javascript {filename="Configuration"} +export const config = { + output: { + // Specify the output format. + format: "ndjson", + }, +}; +``` + +In this example, the scraped data will be saved in newline-delimited JSON (NDJSON) format. Each line in the output file will be a separate JSON object. -- cgit v1.2.3