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 theabstract-blob-store
APIoptions.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:
thisid: `.` uri: bodyuri size:
blobService.get(id, params)
returns output data
of the same form as create
.
blobService.remove(id, params)
Example
;;;; const s3 = accessKeyId: processenvAWS_ACCESS_KEY_ID secretAccessKey: processenvAWS_SECRET_ACCESS_KEY; const blobStore = ; const blobService = ; const blob = uri: blobService;
Should you need to change your bucket's options, such as permissions, pass a params.s3
object using a before hook.
app;
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.