## Public and Private API ## _API documentation automatically generated by [docmeteor](https://github.com/raix/docmeteor)._ *** __File: ["base-common.js"](base-common.js) Where: {server|client}__ *** ############################################################################# HELPERS ############################################################################# - ### *_utility*.defaultZero(val)  Anywhere ### *This method is private* *This method __defaultZero__ is defined in `_Utility`* __Arguments__ * __val__ *{Any}* Returns number or 0 if value is a falsy > ```_Utility.defaultZero = function(val) { ...``` [base-common.js:42](base-common.js#L42) - ### *fsUtility*.cloneFileRecord(rec, [options])  Anywhere ### *This method __cloneFileRecord__ is defined in `FS.Utility`* __Arguments__ * __rec__ *{[FS.File](#FS.File)|[FS.Collection filerecord](#FS.Collection filerecord)}* * __options__ *{Object}* (Optional) * __full__ *{Boolean}* (Optional, Default = false) Set `true` to prevent certain properties from being omitted from the clone. __Returns__ *{Object}* Cloned filerecord Makes a shallow clone of `rec`, filtering out some properties that might be present if it's an FS.File instance, but which we never want to be part of the stored filerecord. This is a blacklist clone rather than a whitelist because we want the user to be able to specify whatever additional properties they wish. In general, we expect the following whitelist properties used by the internal and external APIs: _id, name, size, type, chunkCount, chunkSize, chunkSum, copies, createdAt, updatedAt, uploadedAt Those properties, and any additional properties added by the user, should be present in the returned object, which is suitable for inserting into the backing collection or extending an FS.File instance. > ```FS.Utility.cloneFileRecord = function(rec, options) { ...``` [base-common.js:71](base-common.js#L71) - ### *fsUtility*.defaultCallback([err])  Anywhere ### *This method __defaultCallback__ is defined in `FS.Utility`* __Arguments__ * __err__ *{[Error](#Error)}* (Optional) __Returns__ *{undefined}* Can be used as a default callback for client methods that need a callback. Simply throws the provided error if there is one. > ```FS.Utility.defaultCallback = function defaultCallback(err) { ...``` [base-common.js:96](base-common.js#L96) - ### *fsUtility*.defaultCallback([f], [err])  Anywhere ### *This method __defaultCallback__ is defined in `FS.Utility`* __Arguments__ * __f__ *{Function}* (Optional) A callback function, if you have one. Can be undefined or null. * __err__ *{[Meteor.Error ](#Meteor.Error )|[ Error ](# Error )|[ String](# String)}* (Optional) Error or error message (string) __Returns__ *{Any}* the callback result if any Handle Error, creates an Error instance with the given text. If callback is a function, passes the error to that function. Otherwise throws it. Useful for dealing with errors in methods that optionally accept a callback. > ```FS.Utility.handleError = function(f, err, result) { ...``` [base-common.js:120](base-common.js#L120) - ### *fsUtility*.noop()  Anywhere ### *This method __noop__ is defined in `FS.Utility`* Use this to hand a no operation / empty function > ```FS.Utility.noop = function() { ...``` [base-common.js:134](base-common.js#L134) - ### validateAction(validators, fileObj, userId)  Anywhere ### *This method is private* __Arguments__ * __validators__ *{Object}* The validators object to use, with `deny` and `allow` properties. * __fileObj__ *{[FS.File](#FS.File)}* Mounted or mountable file object to be passed to validators. * __userId__ *{String}* The ID of the user who is attempting the action. __Returns__ *{undefined}* Throws a "400-Bad Request" Meteor error if the file is not mounted or a "400-Access denied" Meteor error if the action is not allowed. > ```FS.Utility.validateAction = function validateAction(validators, fileObj, userId) { ...``` [base-common.js:147](base-common.js#L147) - ### *fsUtility*.getFileName(name)  Anywhere ### *This method is private* *This method __getFileName__ is defined in `FS.Utility`* __Arguments__ * __name__ *{String}* A filename, filepath, or URL __Returns__ *{String}* The filename without the URL, filepath, or query string > ```FS.Utility.getFileName = function utilGetFileName(name) { ...``` [base-common.js:187](base-common.js#L187) - ### *fsUtility*.getFileExtension(name)  Anywhere ### *This method __getFileExtension__ is defined in `FS.Utility`* __Arguments__ * __name__ *{String}* A filename, filepath, or URL that may or may not have an extension. __Returns__ *{String}* The extension or an empty string if no extension found. > ```FS.Utility.getFileExtension = function utilGetFileExtension(name) { ...``` [base-common.js:205](base-common.js#L205) - ### *fsUtility*.setFileExtension(name, ext)  Anywhere ### *This method __setFileExtension__ is defined in `FS.Utility`* __Arguments__ * __name__ *{String}* A filename that may or may not already have an extension. * __ext__ *{String}* An extension without leading period, which you want to be the new extension on `name`. __Returns__ *{String}* The filename with changed extension. > ```FS.Utility.setFileExtension = function utilSetFileExtension(name, ext) { ...``` [base-common.js:222](base-common.js#L222) *** __File: ["base-server.js"](base-server.js) Where: {server}__ *** ### *fsUtility*.binaryToBuffer(data)  Server ### *This method __binaryToBuffer__ is defined in `FS.Utility`* __Arguments__ * __data__ *{Uint8Array}* __Returns__ *{Buffer}* Converts a Uint8Array instance to a Node Buffer instance > ```FS.Utility.binaryToBuffer = function(data) { ...``` [base-server.js:9](base-server.js#L9) - ### *fsUtility*.bufferToBinary(data)  Server ### *This method __bufferToBinary__ is defined in `FS.Utility`* __Arguments__ * __data__ *{Buffer}* __Returns__ *{Uint8Array}* Converts a Node Buffer instance to a Uint8Array instance > ```FS.Utility.bufferToBinary = function(data) { ...``` [base-server.js:26](base-server.js#L26) *** __File: ["base-client.js"](base-client.js) Where: {client}__ *** ### *fsUtility*.eachFile(e, f)  Client ### *This method __eachFile__ is defined in `FS.Utility`* __Arguments__ * __e__ *{[Event](#Event)}* Browser event * __f__ *{Function}* Function to run for each file found in the event. __Returns__ *{undefined}* Utility for iteration over files in event > ```FS.Utility.eachFile = function(e, f) { ...``` [base-client.js:37](base-client.js#L37)