Options
All
  • Public
  • Public/Protected
  • All
Menu

Module interfaces/options/exportingOptions

Index

Type aliases

ExportingFileName

ExportingFileName: string | ((db: string, collection: string, type: "json" | "csv") => string)

The function type that can be used as value of the "fileName" option.

param

The database of the collection that will be exported

param

The the collection that will be exported

param

The type of the collection that will be exported

returns

The file name of the exported collection

ExportingFilePath

ExportingFilePath: string | ((db: string, collection: string, type: "json" | "csv", outPath: string) => string)

The function type of that can be used as value of the "filePath" option.

param

The database of the collection that will be exported

param

The the collection that will be exported

param

The type of the collection that will be exported

param

The file path of the exported collection if this function was not specified

returns

The file path of the exported collection

ExportingOptions

The options about how the collections will be exported. They will define both the options of the mongoexport command and others not regarding it.

See the mongoexport official documentation to further information.

see

https://docs.mongodb.com/manual/reference/program/mongoexport/ to further information on the mongoexport options.

Generated using TypeDoc