Nondeterministic Palindrome Machine

    mongo-gridfs
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    mongo-gridfs

    This is a simple wrapper for the new MongoDB GridFSBucket API.

    The old GridStore-API is now deprecated.

    How to install

    That is simple

    npm install mongo-gridfs

    OR

    yarn add mongo-gridfs

    Usage

    With MongoClient

    const mongoDBConnection = await MongoClient.connect('mongodb://localhost:27017/files');
    let gridFS = new MongoGridFS(mongoDBConnection, "attachments");
    gridFS.findById("59e085f272882d728e2fa4c2").then((item) => {
        console.log(item);
    }).catch((err) => {
        console.error(err);
    });
     

    With Mongoose

    const mongooseConnection = await Mongoose.connect('mongodb://localhost:27017/files');
    let gridFS = new MongoGridFS(mongooseConnection.db, "attachments");
    gridFS.findById("59e085f272882d728e2fa4c2").then((item) => {
        console.log(item);
    }).catch((err) => {
        console.error(err);
    });
     

    Methods

    findById

    By this method you will simple get the meta-object from the MongoDB as a Promise-Object. If nothing found at the Database, then it will reject and the catch-block will be executed.

    gridFS.findById("59e085f272882d728e2fa4c2").then((item) => {
        console.log(item);
    }).catch((err) => {
        console.error(err);
    });

    downloadFile

    You will get the file simple written to the filesystem directly from the Database. If nothing found at the Database, then it will reject and the catch-block will be executed.

    gridFS.downloadFile("59e085f272882d728e2fa4c2", {
        filename: "test.gif",
        targetDir: "/tmp"
    }).then((downloadedFilePath) => {
        console.log(downloadedFilePath);
    }).catch((err) => {
        console.error(err);
    });

    readFileStream

    You will get a GridFSBucketReadStream as Promise. If nothing found at the Database, then it will reject and the catch-block will be executed.

    This method is very useful, to stream the content directly to the user.

    For example with express:

    return gridFS.readFileStream(req.params.id).then((item) => {
        item
        .once("error", () => {
            return res.status(400).end();
        }).pipe(res);
    }).catch(() => res.status(500));

    Install

    npm i mongo-gridfs

    DownloadsWeekly Downloads

    1,251

    Version

    1.1.0

    License

    GPL-3.0

    Unpacked Size

    66.3 kB

    Total Files

    15

    Last publish

    Collaborators

    • quen2404