Connection URL to a MongoDB server
Name of a MongoDB database
Name of the GridFS bucket that will store the files of the file tree
Name of the collection in the Mongo database specified by dbName that will be used for folder storage, store documents representing folders in the file tree
Private _bucketPrivate _bucketPrivate _clientPrivate _currentPrivate _dbPrivate _folderGridFS bucket that stores the files of the file tree.
Name of the GridFS bucket that stores the files of the file tree.
MongoDB client being used for the file tree.
Absolute path of the current working directory of the file tree. This directory is where the files uploaded by the uploadFile method and the folders created by the createFolder method will be located.
Mongo database storing the file tree.
Name of the collection in the Mongo database specified by dbName that will be used for folder storage, storing documents representing folders in the file tree.
Changes the current working directory of the file tree to the absolute path of the directory
specified by the path parameter, which is the folder where files uploaded by the uploadFile method and where new folders
created by the createFolder method will be located. Will raise an error if a directory with
the specified path does not exist.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
//Absolute path, current working directory is now "sample-folder/subfolder-sample"
await fileTree.changeDirectory("sample-folder/subfolder-sample")
//Relative path; absolute path of current working directory is now "sample-folder/subfolder-sample/subfolder-sample-2"
await fileTree.changeDirectory("subfolder-sample-2", true)
If parameter isRelative is false, or not provided, path should be a
string representing the absolute path of a directory that exists in the collection specified by the
folderCollectionName property. If parameter isRelative is true, path is assumed to be relative
to the current working directory. The 'root directory' will have the same name as the folderCollectionName
property.
If true, parameter path must be relative to the current working directory. If false, which is the default value,
parameter path must be the absolute path of a file.
Update the metadata of a file in the file tree, allowing users to add, change, or delete metadata properties from files. Raises an error if the user tries to change or delete the 'path', 'parentDirectory', or 'isLatest' metadata properties from a file.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
await fileTree.changeFileMetadata("sample-folder/sample.txt", {favourite:true}, ["sample-property"], true)
Absolute path of the file that you want to change the metadata of
Optional newMetadata: MetadataOptionsMetadata properties to add or change the value of. Can have any property except the ones listed above.
Optional deleteFields: string[]Metadata properties to delete. Can include any property except the ones listed above.
If false, only changes metadata properties for latest version of file. If true, changes metadata properties for all versions of the file. Defaults to false.
Change the name of a file in the file tree. This also changes its path metadata property accordingly.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
await fileTree.changeFileName("new-file-name", "sample-folder/old-file-name.txt") //File now has path sample-folder/new-file-name.txt
New name for the file
Absolute path of the file that you want to change the name of
Update the metadata of a folder in the file tree, allowing users to add, change, or delete metadata properties from folders. Raises an error if the user tries to change or delete the 'path' and 'parentDirectory' properties from a folder.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
await fileTree.changeFolderMetadata("sample-folder/subfolder", {favorite:true}, ["sample-property"])
Absolute path of the folder that you want to change the name of
Optional newMetadata: MetadataOptionsMetadata properties to add or change the value of. Can have any property except the ones listed above.
Optional deleteFields: string[]Metadata properties to delete. Can have any property except the ones listed above.
Change the name of a folder in the file tree. This also changes its path metadata property accordingly,
and the path and parentDirectory metadata property of all subfolders and files in the folder. Raises an error
if the specified folder does not exist.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
await fileTree.changeFolderName("new-folder-name", "sample-folder/sample-folder-2")
New name for the file
Absolute path of the folder that you want to change the name of
Creates a document representing a folder in the collection specified by folderCollectionName.
Its parent directory will be the current value of the currentWorkingDirectory property.
Will return an error if a folder with the name provided to the method already
exists in the current working directory of the file tree.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
//Creates new folder with path sample-folder/subfolder-sample
let result = await fileTree.createFolder("subfolder-sample") //MongoDB InsertOneResult with the id of the document representing the folder
Name of the folder
Optional customMetadata: MetadataOptionsCustom metadata properties to add to the folder.
Any property can be added except path, isLatest, or parentDirectory.
Deletes all the versions of a file from the GridFS bucket of the file tree.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
await fileTree.deleteFile("sample-folder/sample.txt")
Absolute path to a file that exists in the bucket specified by the bucket
property on the FileTree class
Deletes a folder from the file tree, including all versions of the files in it and its subfolders. If current working directory is about to be deleted, and it is not the root directory, raises en error.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
await fileTree.deleteFolder("sample-folder/subfolder-sample")
Absolute path of a folder that exists in the collection
specified by the folderCollectionName property, or the name of the folder storage collection (folderCollectionName)
If folderPath is the same as folderCollectionName, the collection is not deleted, but all documents in it and
files in the associated GridFS bucket of the file tree will still be deleted.
Lets the user download the folder specified in the folderPath parameter as a zip file. The form which the zip file is returned varies
based on the argument provided for the returnType parameter.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
//Returns an array of bytes (numbers between 255 and 0) representing the data of the zip file
let zip = await fileTree.downloadFolder("sample-folder/subfolder-sample", "array")
String representing the absolute path of the folder
String specifying the form in which the zip file of the target folder should be returned. Valid options are 'base64', 'nodebuffer' (NodeJS buffer), 'array' (array of bytes (numbers between 255 and 0)), 'uint8array','arraybuffer', 'blob', and 'binarystring'.
Returns a promise which resolves to a GridFSBucketReadStream of a file stored in the
GridFS Bucket specified by the bucketName property.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
let stream = await fileTree.getFileReadStream("sample-folder/sample.txt")
Absolute path of the file to get a readable stream of
Upload a file to the GridFS Bucket file tree, with the parent directory of the file being
the current working directory of the file tree.
If a file with the name provided to the method from the options parameter already exists
in the current working directory of the file tree,
the uploaded file will be treated as the latest version of that file, with the
isLatest metadata property of the uploaded file being true and the isLatest property of the
previous file being set to false.
1.0.0
0.1.0
const fileTree = new MongoFileTree("mongodb://localhost:27017", "GridFS-file-tree-management-sample", "sample-bucket", "sample-folder")
// id of the file in file tree GridFS bucket
let id = await fileTree.uploadFile(fs.createReadStream("sample.txt"), {name:"sample.txt", chunkSize:1048576, customMetadata:{favourite:true}})
Valid readable stream
Options for the file. Mandatory properties are name and chunkSize
(the size of the chunks of the file in GridFS in bytes).
The customMetadata property is optional.
Generated using TypeDoc
Stores a file tree in MongoDB using GridFS. Files will be stored in a GridFS Bucket, and the documents in the
filescollection of the bucket will have the following shape:The file tree can store multiple versions of a file. The name of the file cannot have the following characters: /, $, %, ?, @, ", ', !, $, >, <, *, &, {,}, #, =,`, |, :, +, and whitespace characters. An error will be raised if the user attempts to upload a file with those characters in its name or change a file's name to a name that has those characters. The same is true for folder names. The folders of the file tree are stored as documents in a separate collection from the bucket and possess the following shape in MongoDB:
The collection that stores folders is treated as the "root directory" of the file tree, with the root directory's absolute path being the same as the name of the collection. A
FileTreeobject will also have a "current working directory", with the absolute path to it being stored in thecurrentWorkingDirectoryproperty. ThecurrentWorkingDirectoryproperty will be the root directory when initialized. The methods on this class to upload files and create folders automatically puts them under the current working directory. Note: this class automatically connects to MongoDB for all methods.