Skip to content

Commit

Permalink
Add output documentation for clean and raw output options
Browse files Browse the repository at this point in the history
  • Loading branch information
YasogaN committed Nov 29, 2024
1 parent 01c2fd1 commit af55b20
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/outputs/output.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Output

Depending on the value of the variable `clean` set within the options object, the output of the module differs.

## Clean Output

If `clean = true` then please refer to the [clean](https://github.com/YasogaN/google-maps-review-scraper/blob/main/docs/outputs/clean.md) output section


## Raw Output

If `clean = false` or the clean option is not set, then please refer to the [raw](https://github.com/YasogaN/google-maps-review-scraper/blob/main/docs/outputs/raw.md) output section

0 comments on commit af55b20

Please sign in to comment.