fluencelabs/dweb-transports
1
0
Fork 0
mirror of https://github.com/fluencelabs/dweb-transports synced 2025-06-29 12:41:46 +00:00
Code Issues Projects Releases Wiki Activity

Documentation and associated tweaks

Browse Source
This commit is contained in:
Mitra Ardron
2018-04-09 12:12:20 +10:00
parent c0a9c95e16
commit d9c3a77982
12 changed files with 627 additions and 870 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
utils.js
View File

@ -7,72 +7,6 @@ utils = {}; //utility functions
// Utility function to print a array of items but just show number and last.
utils.consolearr = (arr) => ((arr && arr.length >0) ? [arr.length+" items inc:", arr[arr.length-1]] : arr );
/*
//Return true if two shortish arrays a and b intersect or if b is not an array, then if b is in a
//Note there are better solutions exist for longer arrays
//This is intended for comparing two sets of probably equal, but possibly just intersecting URLs
utils.intersects = (a,b) => (Array.isArray(b) ? a.some(x => b.includes(x)) : a.includes(b));
utils.mergeTypedArraysUnsafe = function(a, b) { // Take care of inability to concatenate typed arrays such as Uint8
//http://stackoverflow.com/questions/14071463/how-can-i-merge-typedarrays-in-javascript also has a safe version
const c = new a.constructor(a.length + b.length);
c.set(a);
c.set(b, a.length);
return c;
};
*/
/*
//TODO-STREAM, use this code and return stream from p_rawfetch that this can be applied to
utils.p_streamToBuffer = function(stream, verbose) {
// resolve to a promise that returns a stream.
// Note this comes form one example ...
// There is another example https://github.com/ipfs/js-ipfs/blob/master/examples/exchange-files-in-browser/public/js/app.js#L102 very different
return new Promise((resolve, reject) => {
try {
let chunks = [];
stream
.on('data', (chunk) => { if (verbose) console.log('on', chunk.length); chunks.push(chunk); })
.once('end', () => { if (verbose) console.log('end chunks', chunks.length); resolve(Buffer.concat(chunks)); })
.on('error', (err) => { // Note error behavior untested currently
console.log("Error event in p_streamToBuffer",err);
reject(new errors.TransportError('Error in stream'))
});
stream.resume();
} catch (err) {
console.log("Error thrown in p_streamToBuffer", err);
reject(err);
}
})
};
*/
/*
//TODO-STREAM, use this code and return stream from p_rawfetch that this can be applied to
//TODO-STREAM debugging in streamToBuffer above, copy to here when fixed above
utils.p_streamToBlob = function(stream, mimeType, verbose) {
// resolve to a promise that returns a stream - currently untested as using Buffer
return new Promise((resolve, reject) => {
try {
let chunks = [];
stream
.on('data', (chunk)=>chunks.push(chunk))
.once('end', () =>
resolve(mimeType
? new Blob(chunks, { type: mimeType })
: new Blob(chunks)))
.on('error', (err) => { // Note error behavior untested currently
console.log("Error event in p_streamToBuffer",err);
reject(new errors.TransportError('Error in stream'))
});
stream.resume();
} catch(err) {
console.log("Error thrown in p_streamToBlob",err);
reject(err);
}
})
};
*/
utils.stringfrom = function(foo, hints={}) {
try {
// Generic way to turn anything into a string
@ -85,17 +19,7 @@ utils.stringfrom = function(foo, hints={}) {
throw new errors.CodingError(`Unable to turn ${foo} into a string ${err.message}`)
}
};
/*
utils.objectfrom = function(data, hints={}) {
// Generic way to turn something into a object (typically expecting a string, or a buffer)
return (typeof data === "string" || data instanceof Buffer) ? JSON.parse(data) : data;
}
utils.keyFilter = function(dic, keys) {
// Utility to return a new dic containing each of keys (equivalent to python { dic[k] for k in keys }
return keys.reduce(function(prev, key) { prev[key] = dic[key]; return prev; }, {});
}
*/
utils.p_timeout = function(promise, ms, errorstr) {
/* In a certain period, timeout and reject
promise: A promise we want to watch to completion
@ -115,6 +39,48 @@ utils.p_timeout = function(promise, ms, errorstr) {
]);
}
/*TODO backport these to utils.js in main repo */
utils.createElement = function(tag, attrs, children) { // Note arguments is set to tag, attrs, child1, child2 etc
// Note identical version in dweb-transport/js/utils.js and dweb-transports/utils.js
var element = document.createElement(tag);
for (let name in attrs) {
let attrname = (name.toLowerCase() === "classname" ? "class" : name);
if (name === "dangerouslySetInnerHTML") {
element.innerHTML = attrs[name]["__html"];
delete attrs.dangerouslySetInnerHTML;
}
if (attrs.hasOwnProperty(name)) {
let value = attrs[name];
if (value === true) {
element.setAttribute(attrname, name);
} else if (typeof value === "object" && !Array.isArray(value)) {
if (["style"].includes(attrname)) { // e.g. style: {fontSize: "124px"}
for (let k in value) {
element[attrname][k] = value[k];
}
} else {
// Assume we are really trying to set the value to an object, allow it
element[attrname] = value; // Wont let us use setAttribute(attrname, value) unclear if because unknow attribute or object
}
} else if (value !== false && value != null) {
element.setAttribute(attrname, value.toString());
}
}
}
for (let i = 2; i < arguments.length; i++) { // Everything after attrs
let child = arguments[i];
if (!child) {
} else if (Array.isArray(child)) {
child.map((c) => element.appendChild(c.nodeType == null ?
document.createTextNode(c.toString()) : c))
}
else {
element.appendChild(
child.nodeType == null ?
document.createTextNode(child.toString()) : child);
}
}
return element;
}
exports = module.exports = utils;