documon
Version:
A documentation system for mortals. Use with any language.
286 lines • 9.26 kB
JavaScript
[
{
"text": "Basic, common and simplified asyncronous file methods.\n\n",
"start": 7,
"end": 12,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@package documondocumon",
"flag": "package",
"after": "documon",
"afterType": "documon",
"name": "documon",
"single": true,
"text": "documon"
},
{
"source": "@class fileutils",
"flag": "class",
"after": "fileutils",
"afterType": "fileutils",
"name": "fileutils",
"single": true,
"text": "fileutils"
}
],
"source": "Basic, common and simplified asyncronous file methods.\n\n@package documon\n@class fileutils",
"id": "documon.fileutils"
},
{
"text": "Copies a file from one location to another.\n\n",
"start": 17,
"end": 23,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@method copycopy",
"flag": "method",
"after": "copy",
"afterType": "copy",
"name": "copy",
"single": true,
"text": "copy"
},
{
"source": "@param {string} src - The source file path.The source file path.",
"flag": "param",
"after": "{string} src - The source file path.",
"type": "string",
"afterType": "src - The source file path.",
"name": "src",
"text": "The source file path."
},
{
"source": "@param {string} dest - The destination to copy the source to.",
"flag": "param",
"after": "{string} dest - The destination to copy the source to.",
"type": "string",
"afterType": "dest - The destination to copy the source to.",
"name": "dest",
"text": "The destination to copy the source to."
}
],
"source": "Copies a file from one location to another.\n\n@method copy\n@param {string} src - The source file path.\n@param {string} dest - The destination to copy the source to.",
"id": "documon.fileutils.copy"
},
{
"text": "Reads the entire file as a string. NOTE: This is an alias for [read](#read).\n\n",
"start": 38,
"end": 44,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@method OpenOpen",
"flag": "method",
"after": "Open",
"afterType": "Open",
"name": "Open",
"single": true,
"text": "Open"
},
{
"source": "@param {string} src - The source file path.The source file path.",
"flag": "param",
"after": "{string} src - The source file path.",
"type": "string",
"afterType": "src - The source file path.",
"name": "src",
"text": "The source file path."
},
{
"source": "@return {string} description",
"flag": "return",
"after": "{string} description",
"type": "string",
"afterType": "description",
"name": "description",
"single": true,
"text": "description"
}
],
"source": "Reads the entire file as a string. NOTE: This is an alias for [read](#read).\n\n@method Open\n@param {string} src - The source file path.\n@return {string} description",
"id": "documon.fileutils.Open"
},
{
"text": "Reads the entire file as a string.\n\n",
"start": 46,
"end": 52,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@method readread",
"flag": "method",
"after": "read",
"afterType": "read",
"name": "read",
"single": true,
"text": "read"
},
{
"source": "@param {string} src - The source file path.The source file path.",
"flag": "param",
"after": "{string} src - The source file path.",
"type": "string",
"afterType": "src - The source file path.",
"name": "src",
"text": "The source file path."
},
{
"source": "@return {string} description",
"flag": "return",
"after": "{string} description",
"type": "string",
"afterType": "description",
"name": "description",
"single": true,
"text": "description"
}
],
"source": "Reads the entire file as a string.\n\n@method read\n@param {string} src - The source file path.\n@return {string} description",
"id": "documon.fileutils.read"
},
{
"text": "Saves text data to a file. Overwrites entire file with provided data. NOTE: This is an alias for [write](#write).\n\n",
"start": 61,
"end": 67,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@method savesave",
"flag": "method",
"after": "save",
"afterType": "save",
"name": "save",
"single": true,
"text": "save"
},
{
"source": "@param {string} src - The source file path.The source file path.",
"flag": "param",
"after": "{string} src - The source file path.",
"type": "string",
"afterType": "src - The source file path.",
"name": "src",
"text": "The source file path."
},
{
"source": "@param {string} data - The text data to save.",
"flag": "param",
"after": "{string} data - The text data to save.",
"type": "string",
"afterType": "data - The text data to save.",
"name": "data",
"text": "The text data to save."
}
],
"source": "Saves text data to a file. Overwrites entire file with provided data. NOTE: This is an alias for [write](#write).\n\n@method save\n@param {string} src - The source file path.\n@param {string} data - The text data to save.",
"id": "documon.fileutils.save"
},
{
"text": "Saves text data to a file. Overwrites entire file with provided data.\n\n",
"start": 69,
"end": 75,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@method writewrite",
"flag": "method",
"after": "write",
"afterType": "write",
"name": "write",
"single": true,
"text": "write"
},
{
"source": "@param {string} src - The source file path.The source file path.",
"flag": "param",
"after": "{string} src - The source file path.",
"type": "string",
"afterType": "src - The source file path.",
"name": "src",
"text": "The source file path."
},
{
"source": "@param {string} data - The text data to save.",
"flag": "param",
"after": "{string} data - The text data to save.",
"type": "string",
"afterType": "data - The text data to save.",
"name": "data",
"text": "The text data to save."
}
],
"source": "Saves text data to a file. Overwrites entire file with provided data.\n\n@method write\n@param {string} src - The source file path.\n@param {string} data - The text data to save.",
"id": "documon.fileutils.write"
},
{
"text": "Deletes a file from the system.\n",
"start": 80,
"end": 84,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@method removeremove",
"flag": "method",
"after": "remove",
"afterType": "remove",
"name": "remove",
"single": true,
"text": "remove"
},
{
"source": "@param {string} src - The source file path.",
"flag": "param",
"after": "{string} src - The source file path.",
"type": "string",
"afterType": "src - The source file path.",
"name": "src",
"text": "The source file path."
}
],
"source": "Deletes a file from the system.\n@method remove\n@param {string} src - The source file path.",
"id": "documon.fileutils.remove"
},
{
"text": "Cehcsk to see if a file exists. Note this also checks if a folder of the same name exists too.\n",
"start": 89,
"end": 95,
"file": "/Volumes/Drives/projects/documon/documon/src/fileutils.js",
"flags": [
{
"source": "@method existsexists",
"flag": "method",
"after": "exists",
"afterType": "exists",
"name": "exists",
"single": true,
"text": "exists"
},
{
"source": "@private",
"flag": "private",
"after": ""
},
{
"source": "@param {type} src - The source file path.The source file path.",
"flag": "param",
"after": "{type} src - The source file path.",
"type": "type",
"afterType": "src - The source file path.",
"name": "src",
"text": "The source file path."
},
{
"source": "@return {boolean} - True if exists, false if no file nor folder exists.",
"flag": "return",
"after": "{boolean} - True if exists, false if no file nor folder exists.",
"type": "boolean",
"afterType": "True if exists, false if no file nor folder exists.",
"text": "True if exists, false if no file nor folder exists."
}
],
"source": "Cehcsk to see if a file exists. Note this also checks if a folder of the same name exists too.\n@method exists\n@private\n@param {type} src - The source file path.\n@return {boolean} - True if exists, false if no file nor folder exists.",
"id": "documon.fileutils.exists"
}
]