magick.js
Version:
Node.js interface to the ImageMagick commandline tools
145 lines • 5.2 kB
JSON
{
"project": {
"name": "The ImageMagick.js API",
"description": "The ImageMagick.js API: a Node.js interface to the ImageMagick commandline tools",
"version": "0.0.1",
"url": "http://example.com/"
},
"files": {
"src/options.coffee": {
"name": "src/options.coffee",
"modules": {
"options": 1
},
"classes": {
"inputTypes": 1
},
"fors": {},
"namespaces": {}
}
},
"modules": {
"options": {
"name": "options",
"submodules": {},
"classes": {
"inputTypes": 1
},
"fors": {},
"namespaces": {},
"tag": "module",
"file": "src/options.coffee",
"line": 6
}
},
"classes": {
"inputTypes": {
"name": "inputTypes",
"shortname": "inputTypes",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "options",
"namespace": "",
"file": "src/options.coffee",
"line": 6
}
},
"classitems": [
{
"file": "src/options.coffee",
"line": 12,
"itemtype": "method",
"name": "integer",
"params": [
{
"name": "int",
"description": "The integer to return.",
"type": "Number"
}
],
"return": {
"description": "int as String prefixed with correct sign.",
"type": "String"
},
"class": "inputTypes",
"module": "options"
},
{
"file": "src/options.coffee",
"line": 21,
"itemtype": "method",
"name": "size",
"params": [
{
"name": "options",
"description": "options for how scaling the given should be done.",
"type": "Object",
"props": [
{
"name": "width",
"description": "scale output to this width",
"type": "Integer",
"optional": true
},
{
"name": "height",
"description": "scale output to this height",
"type": "Integer",
"optional": true
},
{
"name": "scale",
"description": "scale output to this percentage of its original size",
"type": "Integer",
"optional": true
},
{
"name": "scaleWidth",
"description": "scale output to a width of this percentage of its original size",
"type": "Integer",
"optional": true
},
{
"name": "scaleHeight",
"description": "scale output to a height of this percentage of its original size",
"type": "Integer",
"optional": true
},
{
"name": "onlyShrink",
"description": "only scale output if it is larger than the set `options.width` or `options.height`",
"type": "Boolean",
"optional": true
},
{
"name": "onlyEnlarge",
"description": "only scale output if it is smaller than the set `options.width` or `options.height`",
"type": "Boolean",
"optional": true
},
{
"name": "fill",
"description": "scale output to fill the set `options.width` and `options.height` completely, cropping if neccessary",
"type": "Boolean",
"optional": true
},
{
"name": "preserveAspect",
"description": "if `true` always preserve the original aspect-ratio",
"type": "Boolean",
"optional": true,
"optdefault": "true"
}
]
}
],
"required": 1,
"class": "inputTypes",
"module": "options"
}
],
"warnings": []
}