mirrors/wekan: The Open Source kanban (built with Meteor). @ 2b51afaedfb790021d63ce2d446b22cbf258c90d

Public and Private API

API documentation automatically generated by docmeteor.

File: "client/Blob.js" Where: {client}

if {any} _Client

Blob.js
A Blob implementation.
2013-06-20
By Eli Grey, http:
By Devin Samarin, https:
License: X11/MIT
See LICENSE.md

-

### <a name="if "></a>if  {any}&nbsp;&nbsp;<sub><i>Client</i></sub> ###
global unescape jslint bitwise: true, regexp: true, confusion: true, es5: true, vars: true, white: true, plusplus: true
if ((typeof Blob !== ``` client/Blob.js:17

File: "client/data-man-api.js" Where: {client}

new DataMan(data, [type]) _Client

Arguments

data {File|Blob|ArrayBuffer|Uint8Array|String}

The data that you want to manipulate.

type {String} (Optional)

The data content (MIME) type, if known. Required if the first argument is an ArrayBuffer, Uint8Array, or URL

DataMan = function DataMan(data, type) { ... client/data-man-api.js:8

dataman.getBlob(callback) _Client

This method getBlob is defined in prototype of DataMan

Arguments

callback {Function}

callback(error, blob)

Returns {undefined}

Passes a Blob representing this data to a callback.

DataMan.prototype.getBlob = function dataManGetBlob(callback) { ... client/data-man-api.js:52

dataman.getBinary([start], [end], callback) _Client

This method getBinary is defined in prototype of DataMan

Arguments

start {Number} (Optional)

First byte position to read.

end {Number} (Optional)

Last byte position to read.

callback {Function}

callback(error, binaryData)

Returns {undefined}

Passes a Uint8Array representing this data to a callback.

DataMan.prototype.getBinary = function dataManGetBinary(start, end, callback) { ... client/data-man-api.js:84

dataman.saveAs([filename]) _Client

This method saveAs is defined in prototype of DataMan

Arguments

filename {String} (Optional)

Returns {undefined}

Tells the browser to save the data like a normal downloaded file, using the provided filename.

DataMan.prototype.saveAs = function dataManSaveAs(filename) { ... client/data-man-api.js:146

dataman.getDataUri(callback) _Client

This method getDataUri is defined in prototype of DataMan

Arguments

callback {function}

callback(err, dataUri)

DataMan.prototype.getDataUri = function dataManGetDataUri(callback) { ... client/data-man-api.js:166

dataman.type() _Client

This method type is defined in prototype of DataMan

Returns the type of the data.

DataMan.prototype.type = function dataManType() { ... client/data-man-api.js:227

dataURItoBlob(dataURI, dataTYPE) _undefined

This method is private

Arguments

dataURI {String}

The data URI

dataTYPE {String}

The content type

Returns {Blob} A new Blob instance

Converts a data URI to a Blob.

function dataURItoBlob(dataURI, dataTYPE) { ... client/data-man-api.js:240

defaultCallback([err]) _undefined

This method is private

Arguments

err {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.

function defaultCallback(err) { ... client/data-man-api.js:255

File: "server/data-man-api.js" Where: {server}

new DataMan(data, [type]) _Server

Arguments

data {Buffer|ArrayBuffer|Uint8Array|String}

The data that you want to manipulate.

type {String} (Optional)

The data content (MIME) type, if known. Required if the first argument is a Buffer, ArrayBuffer, Uint8Array, or URL

DataMan = function DataMan(data, type) { ... server/data-man-api.js:10

dataman.getBuffer([callback]) _Server

This method getBuffer is defined in prototype of DataMan

Arguments

callback {function} (Optional)

callback(err, buffer)

Returns {Buffer|undefined}

Returns a Buffer representing this data, or passes the Buffer to a callback.

DataMan.prototype.getBuffer = function dataManGetBuffer(callback) { ... server/data-man-api.js:54

dataman.saveToFile() _Server

This method saveToFile is defined in prototype of DataMan

Returns {undefined}

Saves this data to a filepath on the local filesystem.

DataMan.prototype.saveToFile = function dataManSaveToFile(filePath) { ... server/data-man-api.js:66

dataman.getDataUri([callback]) _Server

This method getDataUri is defined in prototype of DataMan

Arguments

callback {function} (Optional)

callback(err, dataUri)

If no callback, returns the data URI.

DataMan.prototype.getDataUri = function dataManGetDataUri(callback) { ... server/data-man-api.js:84

dataman.createReadStream() _Server

This method createReadStream is defined in prototype of DataMan

Returns a read stream for the data.

DataMan.prototype.createReadStream = function dataManCreateReadStream() { ... server/data-man-api.js:95

dataman.size([callback]) _Server

This method size is defined in prototype of DataMan

Arguments

callback {function} (Optional)

callback(err, size)

If no callback, returns the size in bytes of the data.

DataMan.prototype.size = function dataManSize(callback) { ... server/data-man-api.js:106

dataman.type() _Server

This method type is defined in prototype of DataMan

Returns the type of the data.

DataMan.prototype.type = function dataManType() { ... server/data-man-api.js:117

File: "server/data-man-buffer.js" Where: {server}

new dataman.Buffer(buffer, type) _Server

This method Buffer is defined in DataMan

Arguments

buffer {Buffer}
type {String}

The data content (MIME) type.

DataMan.Buffer = function DataManBuffer(buffer, type) { ... server/data-man-buffer.js:10

datamanBuffer.getBuffer(callback) _Server

This method is private This method getBuffer is defined in prototype of DataMan.Buffer

Arguments

callback {function}

callback(err, buffer)

Returns {Buffer|undefined}

Passes a Buffer representing the data to a callback.

DataMan.Buffer.prototype.getBuffer = function dataManBufferGetBuffer(callback) { ... server/data-man-buffer.js:24

datamanBuffer.getDataUri(callback) _Server

This method is private This method getDataUri is defined in prototype of DataMan.Buffer

Arguments

callback {function}

callback(err, dataUri)

Passes a data URI representing the data in the buffer to a callback.

DataMan.Buffer.prototype.getDataUri = function dataManBufferGetDataUri(callback) { ... server/data-man-buffer.js:35

datamanBuffer.createReadStream() _Server

This method is private This method createReadStream is defined in prototype of DataMan.Buffer

Returns a read stream for the data.

DataMan.Buffer.prototype.createReadStream = function dataManBufferCreateReadStream() { ... server/data-man-buffer.js:51

datamanBuffer.size(callback) _Server

This method is private This method size is defined in prototype of DataMan.Buffer

Arguments

callback {function}

callback(err, size)

Passes the size in bytes of the data in the buffer to a callback.

DataMan.Buffer.prototype.size = function dataManBufferSize(callback) { ... server/data-man-buffer.js:62

datamanBuffer.type() _Server

This method is private This method type is defined in prototype of DataMan.Buffer

Returns the type of the data.

DataMan.Buffer.prototype.type = function dataManBufferType() { ... server/data-man-buffer.js:80

File: "server/data-man-datauri.js" Where: {server}

new dataman.DataURI(dataUri) _Server

This method DataURI is defined in DataMan

Arguments

dataUri {String}

DataMan.DataURI = function DataManDataURI(dataUri) { ... server/data-man-datauri.js:7

File: "server/data-man-filepath.js" Where: {server}

new dataman.FilePath(filepath, [type]) _Server

This method FilePath is defined in DataMan

Arguments

filepath {String}
type {String} (Optional)

The data content (MIME) type. Will lookup from file if not passed.

DataMan.FilePath = function DataManFilePath(filepath, type) { ... server/data-man-filepath.js:11

datamanFilepath.getBuffer(callback) _Server

This method is private This method getBuffer is defined in prototype of DataMan.FilePath

Arguments

callback {function}

callback(err, buffer)

Returns {Buffer|undefined}

Passes a Buffer representing the data to a callback.

DataMan.FilePath.prototype.getBuffer = function dataManFilePathGetBuffer(callback) { ... server/data-man-filepath.js:25

datamanFilepath.getDataUri(callback) _Server

This method is private This method getDataUri is defined in prototype of DataMan.FilePath

Arguments

callback {function}

callback(err, dataUri)

Passes a data URI representing the data to a callback.

DataMan.FilePath.prototype.getDataUri = function dataManFilePathGetDataUri(callback) { ... server/data-man-filepath.js:43

datamanFilepath.createReadStream() _Server

This method is private This method createReadStream is defined in prototype of DataMan.FilePath

Returns a read stream for the data.

DataMan.FilePath.prototype.createReadStream = function dataManFilePathCreateReadStream() { ... server/data-man-filepath.js:67

datamanFilepath.size(callback) _Server

This method is private This method size is defined in prototype of DataMan.FilePath

Arguments

callback {function}

callback(err, size)

Passes the size in bytes of the data to a callback.

DataMan.FilePath.prototype.size = function dataManFilePathSize(callback) { ... server/data-man-filepath.js:79

datamanFilepath.type() _Server

This method is private This method type is defined in prototype of DataMan.FilePath

Returns the type of the data.

DataMan.FilePath.prototype.type = function dataManFilePathType() { ... server/data-man-filepath.js:104

File: "server/data-man-url.js" Where: {server}

new dataman.URL(url, type) _Server

This method URL is defined in DataMan

Arguments

url {String}
type {String}

The data content (MIME) type.

DataMan.URL = function DataManURL(url, type) { ... server/data-man-url.js:10

datamanUrl.getBuffer(callback) _Server

This method is private This method getBuffer is defined in prototype of DataMan.URL

Arguments

callback {function}

callback(err, buffer)

Returns {Buffer|undefined}

Passes a Buffer representing the data at the URL to a callback.

DataMan.URL.prototype.getBuffer = function dataManUrlGetBuffer(callback) { ... server/data-man-url.js:24

datamanUrl.getDataUri(callback) _Server

This method is private This method getDataUri is defined in prototype of DataMan.URL

Arguments

callback {function}

callback(err, dataUri)

Passes a data URI representing the data at the URL to a callback.

DataMan.URL.prototype.getDataUri = function dataManUrlGetDataUri(callback) { ... server/data-man-url.js:57

datamanUrl.createReadStream() _Server

This method is private This method createReadStream is defined in prototype of DataMan.URL

Returns a read stream for the data.

DataMan.URL.prototype.createReadStream = function dataManUrlCreateReadStream() { ... server/data-man-url.js:85

datamanUrl.size(callback) _Server

This method is private This method size is defined in prototype of DataMan.URL

Arguments

callback {function}

callback(err, size)

Returns the size in bytes of the data at the URL.

DataMan.URL.prototype.size = function dataManUrlSize(callback) { ... server/data-man-url.js:97

datamanUrl.type() _Server

This method is private This method type is defined in prototype of DataMan.URL

Returns the type of the data.

DataMan.URL.prototype.type = function dataManUrlType() { ... server/data-man-url.js:121

internal.api.md 16 KB Riwayat Mentahan

Public and Private API

if {any} Client

new DataMan(data, [type]) Client

dataman.getBlob(callback) Client

dataman.getBinary([start], [end], callback) Client

dataman.saveAs([filename]) Client

dataman.getDataUri(callback) Client

dataman.type() Client

dataURItoBlob(dataURI, dataTYPE) undefined

defaultCallback([err]) undefined

new DataMan(data, [type]) Server

dataman.getBuffer([callback]) Server

dataman.saveToFile() Server

dataman.getDataUri([callback]) Server

dataman.createReadStream() Server

dataman.size([callback]) Server

dataman.type() Server

new dataman.Buffer(buffer, type) Server

datamanBuffer.getBuffer(callback) Server

datamanBuffer.getDataUri(callback) Server

datamanBuffer.createReadStream() Server

datamanBuffer.size(callback) Server

datamanBuffer.type() Server

new dataman.DataURI(dataUri) Server

new dataman.FilePath(filepath, [type]) Server

datamanFilepath.getBuffer(callback) Server

datamanFilepath.getDataUri(callback) Server

datamanFilepath.createReadStream() Server

datamanFilepath.size(callback) Server

datamanFilepath.type() Server

new dataman.URL(url, type) Server

datamanUrl.getBuffer(callback) Server

datamanUrl.getDataUri(callback) Server

datamanUrl.createReadStream() Server

datamanUrl.size(callback) Server

datamanUrl.type() Server

internal.api.md 16 KB

Riwayat Mentahan

if {any} _Client

new DataMan(data, [type]) _Client

dataman.getBlob(callback) _Client

dataman.getBinary([start], [end], callback) _Client

dataman.saveAs([filename]) _Client

dataman.getDataUri(callback) _Client

dataman.type() _Client

dataURItoBlob(dataURI, dataTYPE) _undefined

defaultCallback([err]) _undefined

new DataMan(data, [type]) _Server

dataman.getBuffer([callback]) _Server

dataman.saveToFile() _Server

dataman.getDataUri([callback]) _Server

dataman.createReadStream() _Server

dataman.size([callback]) _Server

dataman.type() _Server

new dataman.Buffer(buffer, type) _Server

datamanBuffer.getBuffer(callback) _Server

datamanBuffer.getDataUri(callback) _Server

datamanBuffer.createReadStream() _Server

datamanBuffer.size(callback) _Server

datamanBuffer.type() _Server

new dataman.DataURI(dataUri) _Server

new dataman.FilePath(filepath, [type]) _Server

datamanFilepath.getBuffer(callback) _Server

datamanFilepath.getDataUri(callback) _Server

datamanFilepath.createReadStream() _Server

datamanFilepath.size(callback) _Server

datamanFilepath.type() _Server

new dataman.URL(url, type) _Server

datamanUrl.getBuffer(callback) _Server

datamanUrl.getDataUri(callback) _Server

datamanUrl.createReadStream() _Server

datamanUrl.size(callback) _Server

datamanUrl.type() _Server