API Docs for: 0.8.0
Show:

MongoMediaProvider Class

Defined in: include/service/media/mongo_media_provider.js:26
Module: Services

A media provider that uses Mongo's GridFS as the method of storage.

Constructor

MongoMediaProvider

(
  • context
)

Defined in include/service/media/mongo_media_provider.js:26

Parameters:

  • context Object
    • site String

Methods

createWriteStream

(
  • mediaPath
  • cb
)

Defined in include/service/media/mongo_media_provider.js:156

Not Implemented

Parameters:

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • cb Function

    A callback that provides two parameters: An Error, if occurred and a WriteableStream.

delete

(
  • mediaPath
  • cb
)

Defined in include/service/media/mongo_media_provider.js:187

Deletes a file from the GridFS

Parameters:

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • cb Function

    A callback that provides two parameters: An Error, if occurred and the success of the operation.

exists

(
  • mediaPath
  • cb
)

Defined in include/service/media/mongo_media_provider.js:168

Checks to see if the file actually exists in GridFS

Parameters:

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • cb Function

    A callback that provides two parameters: An Error, if occurred and a Boolean.

get

(
  • mediaPath
  • cb
)

Defined in include/service/media/mongo_media_provider.js:63

Retrieves the content from GridFS as a String or Buffer.

Parameters:

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • cb Function

    A callback that provides two parameters: An Error, if occurred and an entity that contains the media content.

getStream

(
  • mediaPath
  • [options]
  • cb
)

Defined in include/service/media/mongo_media_provider.js:35

Retrieves the item in GridFS as a stream.

Parameters:

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • [options] Object optional

    Options for interacting with S3

    • [bucket] String optional

      The S3 bucket to interact with

  • cb Function

    A callback that provides two parameters: An Error, if occurred and a ReadableStream that contains the media content.

setStream

(
  • stream
  • mediaPath
  • cb
)

Defined in include/service/media/mongo_media_provider.js:97

Sets media content into GridFS based on the specified media path and options. The stream provided must be a ReadableStream.

Parameters:

  • stream ReadableStream

    The content stream

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • cb Function

    A callback that provides two parameters: An Error, if occurred and the success of the operation.

setStream

(
  • fileDataStrOrBuffOrStream
  • mediaPath
  • cb
)

Defined in include/service/media/mongo_media_provider.js:124

Sets media content into GridFS based on the specified media path and options. The data must be in the form of a String or Buffer.

Parameters:

  • fileDataStrOrBuffOrStream String | Buffer

    The content to persist

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • cb Function

    A callback that provides two parameters: An Error, if occurred and the success of the operation.

stat

(
  • mediaPath
  • cb
)

Defined in include/service/media/mongo_media_provider.js:206

Retrieve the stats on the file

Parameters:

  • mediaPath String

    The path/key to the media. Typically this is a path such as: /media/2014/9/540a3ff0e30ddfb9e60000be-1409957872680.jpg

  • cb Function

    A callback that provides two parameters: An Error, if occurred and an object that contains the file stats