feathers-blob
Advanced tools
Feathers
abstract blob storeservice
npm install feathers-blob --save
Also install a abstract-blob-store compatible module.
const BlobService = require('feathers-blob')blobService = BlobService(options)options.Model is an instantiated interface that implements the abstract-blob-store APIoptions.id is a string 'key' for the blob identifier.blobService.create(body, params)where input body is an object with either:
uri pointing to data URI of the blob,buffer pointing to raw data buffer of the blob along with its contentType (i.e. MIME type).Optionally, you can specify in the body the blob id which can be the file
path where you want to store the file, otherwise it would default to
${hash(content)}.${extension(contentType)}.
Tip: You can use feathers hooks to customize the id. You might not want the
client-side to write whereever they want.
returns output 'data' of the form:
{
[this.id]: `${hash(content)}.${extension(contentType)}`,
uri: body.uri,
size: length(content)
}
blobService.get(id, params)returns output data of the same form as create.
blobService.remove(id, params)const { getBase64DataURI } = require('dauria');
const AWS = require('aws-sdk');
const S3BlobStore = require('s3-blob-store');
const feathers = require('@feathersjs/feathers');
const BlobService = require('feathers-blob');
const s3 = new AWS.S3({
endpoint: 'https://{service}.{region}.{provider}.com',
accessKeyId: process.env.AWS_ACCESS_KEY_ID,
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
});
const blobStore = S3BlobStore({
client: s3,
bucket: 'feathers-blob'
});
const blob = {
uri: getBase64DataURI(new Buffer('hello world'), 'text/plain')
}
const app = feathers();
app.use('/upload', BlobService({
Model: blobStore
}));
const blobService = app.service('upload');
blobService.create(blob).then(function (result) {
console.log('Stored blob with id', result.id);
}).catch(err => {
console.error(err);
});
Should you need to change your bucket's options, such as permissions, pass a params.s3 object using a before hook.
app.service('upload').before({
create(hook) {
hook.params.s3 = { ACL: 'public-read' }; // makes uploaded files public
}
});
For a more complete example, see examples/app which can be run with npm run example.
Copyright (c) 2018
Licensed under the MIT license.
v2.1.0 (2019-03-09)
Closed issues:
Merged pull requests:
FAQs
Feathers blob service
The npm package feathers-blob receives a total of 2,040 weekly downloads. As such, feathers-blob popularity was classified as popular.
We found that feathers-blob demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."