Configuration

reddinx ships with sane defaults, but you can further customize it by creating a reddinx.config.js file at the root of your project.

The file accepts the following keys (note that you can also pass them directly as an options object to the initial and incremental methods)

name	description	default value
dataPath	Directory where the final records are saved	./data
cachePath	Directory where the HTTP requests are cached	./.cache
onEach	Method called on each record before saving it to disk	Does nothing
incrementalWindow	How far back should the incremental import update old records	[7, 'days']

dataPath

By default, all records are saved in the ./data folder. You can change the path here if you'd rather have it saved somewhere else.

Note that it won't change the way records are stored in a YYYY/MM/DD folder structure inside the directory.

cachePath

To limit the number of HTTP requests made, reddinx caches all of them on disk in the ./.cache folder. You can change the location of the cached folder here.

Note that if you ever want to restart an import from scratch, with a clean state, deleting this directory could be a good idea.

onEach

This hook is called on each record, right before saving it to disk. This is your chance to alter the data for your specific use-case right before it is saved on disk.

It takes the record as input, and expect a record as output. If you return false from it, it will not save the record on disk and will actually delete the record if it was already saved. The method can be async.

incrementalWindow

When doing an incremental import, reddinx will update posts in the past up to this value. The more you increase it, the most up-to-date data you will have, but it's useless to try to go to far back in time as if posts are too old, they are rarely updated and your data is already good enough.