Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quen2404/mongo-gridfs
Uses the native GridFSBucket from the new MongoDB Driver and wrap it as Promise
https://github.com/quen2404/mongo-gridfs
async es6 gridfs gridfs-bucket gridfsbucket mongo mongodb mongoose native-promise nodejs typescript
Last synced: about 2 months ago
JSON representation
Uses the native GridFSBucket from the new MongoDB Driver and wrap it as Promise
- Host: GitHub
- URL: https://github.com/quen2404/mongo-gridfs
- Owner: quen2404
- License: gpl-3.0
- Created: 2018-09-19T15:01:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T04:18:15.000Z (over 3 years ago)
- Last Synced: 2024-10-24T00:08:44.127Z (2 months ago)
- Topics: async, es6, gridfs, gridfs-bucket, gridfsbucket, mongo, mongodb, mongoose, native-promise, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 238 KB
- Stars: 8
- Watchers: 3
- Forks: 5
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# mongo-gridfs
This is a simple wrapper for the new [MongoDB GridFSBucket API](http://mongodb.github.io/node-mongodb-native/3.0/tutorials/gridfs/streaming/).
The old GridStore-API is now [deprecated](http://mongodb.github.io/node-mongodb-native/3.0/tutorials/gridfs/gridstore/).
## How to install
That is simple
`npm install mongo-gridfs`
OR
`yarn add mongo-gridfs`
## Usage
### With MongoClient
```js
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
```js
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.
```js
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.
```js
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:
```js
return gridFS.readFileStream(req.params.id).then((item) => {
item
.once("error", () => {
return res.status(400).end();
}).pipe(res);
}).catch(() => res.status(500));
```