wekan/packages/wekan-cfs-collection-filters/api.md

cfs-collection-filters Public API

CollectionFS, adds FS.Collection filters

API documentation automatically generated by docmeteor.

-

fsCollection.filters(filters)  _Anywhere

This method filters is defined in prototype of FS.Collection

Arguments

• filters {Object}
  

File filters for this collection.

Returns {undefined}

FS.Collection.prototype.filters = function fsColFilters(filters) { ... filters.js:7

-

fsCollection.allowsFile()  _Anywhere

This method allowsFile is defined in prototype of FS.Collection

Returns {boolean} True if the collection allows this file.

Checks based on any filters defined on the collection. If the file is not valid according to the filters, this method returns false and also calls the filter onInvalid method defined for the collection, passing it an English error string that explains why it failed.

FS.Collection.prototype.allowsFile = function fsColAllowsFile(fileObj) { ... filters.js:108