feathers-blob

feathers-blob

Feathers abstract blob store service

Installation

npm install feathers-blob --save

Also install a abstract-blob-store compatible module.

API

import BlobService from 'feathers-blob'

blobService = BlobService(options)

• options.Model is an instantiated interface that implements the abstract-blob-store API
• options.id is a string 'key' for the blob identifier.

blobService.create(body, params)

where input body is an object with key uri pointing to data URI of the blob.

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)

Example

import { getBase64DataURI } from 'dauria';
import AWS from 'aws-sdk';
import S3BlobStore from 's3-blob-store';
import BlobService from '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 blobService = BlobService({
  Model: blobStore
});

const blob = {
  uri: getBase64DataURI(new Buffer('hello world'), 'text/plain')
}

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.

License

Copyright (c) 2016

Licensed under the MIT license.

Changelog

v1.4.0 (2018-02-16)

Full Changelog

Closed issues:

• List of files/blob #5

Merged pull requests:

• return deleted id to avoid 404 error #36 (lwhiteley)
• Update s3-blob-store to the latest version 🚀 #34 (greenkeeper[bot])
• endpoint option #33 (sarkistlt)
• Update mocha to the latest version 🚀 #32 (greenkeeper[bot])
• Update semistandard to the latest version 🚀 #31 (greenkeeper[bot])
• Wrong field name for custom id in create method #28 (NikitaVlaznev)
• Update mocha to the latest version 🚀 #27 (greenkeeper[bot])
• Update debug to the latest version 🚀 #26 (greenkeeper[bot])