wekan/packages/wekan-cfs-gridfs/api.md

cfs-gridfs Public API

GridFS storage adapter for CollectionFS

API documentation automatically generated by docmeteor.

-

new fsStore.GridFS(name, options)  _Server

This method GridFS is defined in FS.Store

Arguments

• name {String}
  

The store name

• options {Object}

  • beforeSave {Function} (Optional)

  Function to run before saving a file from the server. The context of the function will be the FS.File instance we're saving. The function may alter its properties.

  • maxTries {Number} (Optional, Default = 5)

  Max times to attempt saving a file

Returns {FS.StorageAdapter} An instance of FS.StorageAdapter.

Creates a GridFS store instance on the server. Inherits from FS.StorageAdapter type.

FS.Store.GridFS = function(name, options) { ... gridfs.server.js:16

-

new fsStore.GridFS(name, options)  _Client

This method GridFS is defined in FS.Store

Arguments

• name {String}
  

The store name

• options {Object}

  • beforeSave {Function} (Optional)

  Function to run before saving a file from the client. The context of the function will be the FS.File instance we're saving. The function may alter its properties.

  • maxTries {Number} (Optional, Default = 5)

  Max times to attempt saving a file

Returns {undefined}

Creates a GridFS store instance on the client, which is just a shell object storing some info.

FS.Store.GridFS = function(name, options) { ... gridfs.client.js:13