grid-fs
Convenience wrappers around MongoDB GridFS methods.
v1.0.0+ requires at least Node.js v6
Installation
npm install grid-fs --save
Usage
Require GridFs constructor and create a gridFs instance
const GridFs = ;const gridFs = db collectionName;
Where
- db is a opened database instance
- collectionName (optional, defaults to
'fs'
) is the collection name for the stored files
Example
const MongoClient = MongoClient;const GridFs = ;MongoClient;
List file data
gridFs
Where
- filename is the name of the file to list
- callback is the function to run with arguments (err, info). Info object contains the following properties
- filename
- contentType
- uploadDate – Date object
- length – length in bytes
- metadata – metadata object used when creating the write stream
- internalMd5 – MD5 hash of the contents
Example
gridFs;
List all files
List all files in the collection
gridFs
Where
- callback is the function to run when file list is fetched, uses arguments (err, list) where list is an array of file names
Example
gridFs;
Write files to GridFs
Create Writable stream
let stream = gridFs;
Where
- filename is the name of file to write to (overwrites existing file if present)
- options is the optional options object (
metadata
object property is probably most important)
Listen for the 'close'
event to find out when the file has been stored to the GridFs
Example
let stream = gridFs;stream;stream;
Read files from GridFs
Create Readable stream
let stream = gridFs;
Where
- filename is the name of the file to read from
Example
let stream = gridFs;stream;
Delete files from GridFs
Unlink a file with
gridFs;
Where
- filename is the name of the file to unlink
- callback is the function to run once the file is deleted
Example
gridFs;
License
MIT