webgme-engine
Version:
WebGME server and Client API without a GUI
151 lines (122 loc) • 7.15 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: common/blob/BlobMetadata.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: common/blob/BlobMetadata.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/*globals define*/
/*eslint-env node, browser*/
/**
* Client module for accessing the blob.
*
* @author lattmann / https://github.com/lattmann
*/
define(['blob/BlobConfig'], function (BlobConfig) {
'use strict';
/**
* Initializes a new instance of BlobMetadata
* @param {object} metadata - A serialized metadata object.
* @param {string} metadata.name
* @param {string|Object} metadata.content
* @param {number} [metadata.size=0]
* @param {BlobMetadata.CONTENT_TYPES} [metadata.contentType=BlobMetadata.CONTENT_TYPES.OBJECT]
* @param {string} [metadata.mime='']
* @param {boolean} [metadata.isPublic=false]
* @param {string[]} [metadata.tags=[]]
* @constructor
* @alias BlobMetadata
*/
var BlobMetadata = function (metadata) {
var key;
if (metadata) {
this.name = metadata.name;
this.size = metadata.size || 0;
this.mime = metadata.mime || '';
this.isPublic = metadata.isPublic || false;
this.tags = metadata.tags || [];
this.content = metadata.content;
this.contentType = metadata.contentType || BlobMetadata.CONTENT_TYPES.OBJECT;
if (this.contentType === BlobMetadata.CONTENT_TYPES.COMPLEX) {
for (key in this.content) {
if (Object.hasOwn(this.content, key)) {
if (BlobConfig.hashRegex.test(this.content[key].content) === false) {
throw new Error('BlobMetadata is malformed: hash \'' + this.content[key].content +
'\'is invalid');
}
}
}
}
} else {
throw new Error('metadata parameter is not defined');
}
};
/**
* Type of the metadata
* @type {{OBJECT: string, COMPLEX: string, SOFT_LINK: string}}
*/
BlobMetadata.CONTENT_TYPES = {
OBJECT: 'object',
COMPLEX: 'complex',
SOFT_LINK: 'softLink'
};
/**
* Serializes the metadata to a JSON object.
* @returns {{
* name: string,
* size: number,
* mime: string,
* tags: Array.<string>,
* content: (string|Object),
* contentType: string}}
*/
BlobMetadata.prototype.serialize = function () {
var metadata = {
name: this.name,
size: this.size,
mime: this.mime,
isPublic: this.isPublic,
tags: this.tags,
content: this.content,
contentType: this.contentType
};
metadata.tags.sort();
if (this.contentType === BlobMetadata.CONTENT_TYPES.COMPLEX) {
// override on purpose to normalize content
metadata.content = {};
var fnames = Object.keys(this.content);
fnames.sort();
for (var j = 0; j < fnames.length; j += 1) {
metadata.content[fnames[j]] = this.content[fnames[j]];
}
}
return metadata;
};
return BlobMetadata;
});
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="Server_GMEAuth.html">Server:GMEAuth</a></li><li><a href="Server_SafeStorage.html">Server:SafeStorage</a></li><li><a href="Server_UserProject.html">Server:UserProject</a></li><li><a href="module-Core.html">Core</a></li><li><a href="module-Storage.html">Storage</a></li><li><a href="module-crosscuts.html">crosscuts</a></li><li><a href="module-serialization.html">serialization</a></li></ul><h3>Externals</h3><ul><li><a href="external-Promise.html">Promise</a></li></ul><h3>Classes</h3><ul><li><a href="AddOnBase.html">AddOnBase</a></li><li><a href="AddOnUpdateResult.html">AddOnUpdateResult</a></li><li><a href="Artifact.html">Artifact</a></li><li><a href="BlobClient.html">BlobClient</a></li><li><a href="BlobMetadata.html">BlobMetadata</a></li><li><a href="BlobRunPluginClient.html">BlobRunPluginClient</a></li><li><a href="Client.html">Client</a></li><li><a href="Core.html">Core</a></li><li><a href="ExecutorClient.html">ExecutorClient</a></li><li><a href="GMENode.html">GMENode</a></li><li><a href="GmeLogger.html">GmeLogger</a></li><li><a href="InterPluginResult.html">InterPluginResult</a></li><li><a href="JobInfo.html">JobInfo</a></li><li><a href="OutputInfo.html">OutputInfo</a></li><li><a href="PluginBase.html">PluginBase</a></li><li><a href="PluginConfig.html">PluginConfig</a></li><li><a href="PluginMessage.html">PluginMessage</a></li><li><a href="PluginNodeDescription.html">PluginNodeDescription</a></li><li><a href="PluginResult.html">PluginResult</a></li><li><a href="Project.html">Project</a></li><li><a href="ProjectInterface.html">ProjectInterface</a></li><li><a href="Server_GMEAuth-GMEAuth.html">GMEAuth</a></li><li><a href="Server_SafeStorage-SafeStorage.html">SafeStorage</a></li><li><a href="Server_UserProject-UserProject.html">UserProject</a></li><li><a href="WebsocketRouter.html">WebsocketRouter</a></li><li><a href="WebsocketRouterUser.html">WebsocketRouterUser</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:BRANCH_CHANGED">BRANCH_CHANGED</a></li><li><a href="Client.html#event:BRANCH_CLOSED">BRANCH_CLOSED</a></li><li><a href="Client.html#event:BRANCH_OPENED">BRANCH_OPENED</a></li><li><a href="Client.html#event:BRANCH_STATUS_CHANGED">BRANCH_STATUS_CHANGED</a></li><li><a href="Client.html#event:CONNECTED_USERS_CHANGED">CONNECTED_USERS_CHANGED</a></li><li><a href="Client.html#event:NETWORK_STATUS_CHANGED">NETWORK_STATUS_CHANGED</a></li><li><a href="Client.html#event:NOTIFICATION">NOTIFICATION</a></li><li><a href="Client.html#event:PLUGIN_FINISHED">PLUGIN_FINISHED</a></li><li><a href="Client.html#event:PLUGIN_INITIATED">PLUGIN_INITIATED</a></li><li><a href="Client.html#event:PLUGIN_NOTIFICATION">PLUGIN_NOTIFICATION</a></li><li><a href="Client.html#event:PROJECT_CLOSED">PROJECT_CLOSED</a></li><li><a href="Client.html#event:PROJECT_OPENED">PROJECT_OPENED</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Jun 21 2024 09:43:40 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>