From fea5989937c933f40877f7ec1b9d6b314f233a43 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Thu, 17 Apr 2025 14:13:09 +0200 Subject: [PATCH 1/3] import tags and functions from lucee --- data/en/abort.json | 27 + data/en/aigetmetadata.json | 24 + data/en/aihas.json | 15 + data/en/ajaximport.json | 31 ++ data/en/ajaxproxy.json | 45 ++ data/en/application.json | 660 +++++++++++++++++++++++++ data/en/applicationpathcacheclear.json | 12 + data/en/argument.json | 59 +++ data/en/arrayremoveduplicates.json | 25 + data/en/associate.json | 24 + data/en/authenticate.json | 9 + data/en/break.json | 15 + data/en/cache.json | 136 +++++ data/en/case.json | 24 + data/en/catch.json | 24 + data/en/col.json | 38 ++ data/en/collection.json | 59 +++ data/en/component.json | 136 +++++ data/en/componentlistpackage.json | 15 + data/en/configtranslate.json | 46 ++ data/en/content.json | 59 +++ data/en/continue.json | 15 + data/en/cookie.json | 89 ++++ data/en/createaisession.json | 39 ++ data/en/createulid.json | 34 ++ data/en/dbinfo.json | 81 +++ data/en/debugadd.json | 22 + data/en/defaultcase.json | 9 + data/en/directory.json | 132 +++++ data/en/directoryinfo.json | 18 + data/en/document.json | 276 +++++++++++ data/en/documentitem.json | 31 ++ data/en/documentsection.json | 94 ++++ data/en/dump.json | 122 +++++ data/en/else.json | 9 + data/en/elseif.json | 15 + data/en/encodeforsql.json | 30 ++ data/en/error.json | 38 ++ data/en/execute.json | 114 +++++ data/en/exit.json | 15 + data/en/extensioninfo.json | 17 + data/en/feed.json | 137 +++++ data/en/file.json | 167 +++++++ data/en/fileinfo.json | 18 + data/en/filemodetosymbolic.json | 17 + data/en/filetouch.json | 22 + data/en/finally.json | 9 + data/en/findlast.json | 32 ++ data/en/findlastnocase.json | 32 ++ data/en/flush.json | 24 + data/en/forward.json | 15 + data/en/ftp.json | 227 +++++++++ data/en/function.json | 150 ++++++ data/en/gatewayaction.json | 38 ++ data/en/gatewaystate.json | 17 + data/en/generate3deskey.json | 14 + data/en/generatersakeys.json | 16 + data/en/getcomponentstaticscope.json | 15 + data/en/getcontextinfo.json | 12 + data/en/gethttprequestheaders.json | 12 + data/en/getpropertyfile.json | 26 + data/en/getpropertystring.json | 32 ++ data/en/getsecret.json | 22 + data/en/getsystemproporenvvar.json | 17 + data/en/header.json | 45 ++ data/en/htmlbody.json | 45 ++ data/en/htmlhead.json | 45 ++ data/en/http.json | 284 +++++++++++ data/en/httpparam.json | 52 ++ data/en/if.json | 15 + data/en/image.json | 157 ++++++ data/en/imagecoderinfo.json | 15 + data/en/imagewritetobrowser.json | 15 + data/en/imap.json | 150 ++++++ data/en/import.json | 31 ++ data/en/include.json | 31 ++ data/en/inquiryaisession.json | 30 ++ data/en/inspecttemplates.json | 13 + data/en/interface.json | 31 ++ data/en/internalrequest.json | 80 +++ data/en/interruptthread.json | 14 + data/en/invokeargument.json | 31 ++ data/en/isflushed.json | 12 + data/en/iswithintransaction.json | 12 + data/en/ldap.json | 185 +++++++ data/en/listgetduplicates.json | 40 ++ data/en/listqualifiedtoarray.json | 49 ++ data/en/loadaisession.json | 23 + data/en/lock.json | 52 ++ data/en/logallthreads.json | 33 ++ data/en/login.json | 31 ++ data/en/loginuser.json | 31 ++ data/en/logout.json | 9 + data/en/loop.json | 178 +++++++ data/en/lslcase.json | 25 + data/en/lsucase.json | 25 + data/en/luceeaigetmetadata.json | 24 + data/en/luceeaihas.json | 15 + data/en/luceecreateaisession.json | 39 ++ data/en/luceeinquiryaisession.json | 30 ++ data/en/mail.json | 248 ++++++++++ data/en/mailparam.json | 73 +++ data/en/mailpart.json | 31 ++ data/en/markdowntohtml.json | 35 ++ data/en/maveninfo.json | 52 ++ data/en/mavenload.json | 18 + data/en/module.json | 9 + data/en/object.json | 122 +++++ data/en/objectcache.json | 45 ++ data/en/output.json | 59 +++ data/en/pageencoding.json | 15 + data/en/param.json | 59 +++ data/en/pdf.json | 325 ++++++++++++ data/en/pdfparam.json | 31 ++ data/en/pop.json | 129 +++++ data/en/processingdirective.json | 38 ++ data/en/procparam.json | 73 +++ data/en/procresult.json | 31 ++ data/en/property.json | 73 +++ data/en/queryclose.json | 17 + data/en/querygetcellbyindex.json | 38 ++ data/en/queryisempty.json | 17 + data/en/queryparam.json | 77 +++ data/en/queryrenamecolumn.json | 32 ++ data/en/queryrowbyindex.json | 31 ++ data/en/queryrowdatabyindex.json | 31 ++ data/en/querytostruct.json | 41 ++ data/en/registry.json | 66 +++ data/en/rethrow.json | 9 + data/en/retry.json | 9 + data/en/return.json | 15 + data/en/s3addacl.json | 60 +++ data/en/s3clearbucket.json | 52 ++ data/en/s3copy.json | 80 +++ data/en/s3createbucket.json | 59 +++ data/en/s3delete.json | 58 +++ data/en/s3deletebucket.json | 51 ++ data/en/s3download.json | 66 +++ data/en/s3exists.json | 52 ++ data/en/s3generatepresignedurl.json | 129 +++++ data/en/s3generateuri.json | 68 +++ data/en/s3getacl.json | 53 ++ data/en/s3getmetadata.json | 53 ++ data/en/s3getversioninfo.json | 52 ++ data/en/s3listbucket.json | 60 +++ data/en/s3listbuckets.json | 38 ++ data/en/s3move.json | 80 +++ data/en/s3read.json | 59 +++ data/en/s3readbinary.json | 52 ++ data/en/s3setacl.json | 60 +++ data/en/s3setmetadata.json | 59 +++ data/en/s3upload.json | 72 +++ data/en/s3write.json | 87 ++++ data/en/sanitize.json | 25 + data/en/savecontent.json | 31 ++ data/en/schedule.json | 214 ++++++++ data/en/script.json | 15 + data/en/search.json | 136 +++++ data/en/serializeaisession.json | 24 + data/en/servlet.json | 45 ++ data/en/servletparam.json | 38 ++ data/en/sessioncommit.json | 12 + data/en/sessionexists.json | 12 + data/en/set.json | 15 + data/en/setpropertystring.json | 38 ++ data/en/setting.json | 71 +++ data/en/silent.json | 15 + data/en/static.json | 12 + data/en/stopwatch.json | 24 + data/en/storedproc.json | 94 ++++ data/en/switch.json | 15 + data/en/table.json | 66 +++ data/en/thread.json | 67 +++ data/en/threaddata.json | 12 + data/en/threadinterrupt.json | 14 + data/en/timeout.json | 41 ++ data/en/timer.json | 40 ++ data/en/transaction.json | 24 + data/en/trimwhitespace.json | 14 + data/en/try.json | 9 + data/en/update.json | 59 +++ data/en/valueref.json | 18 + data/en/wddx.json | 59 +++ data/en/while.json | 24 + data/en/xml.json | 39 ++ data/en/zip.json | 136 +++++ data/en/zipparam.json | 80 +++ 187 files changed, 10438 insertions(+) create mode 100644 data/en/abort.json create mode 100644 data/en/aigetmetadata.json create mode 100644 data/en/aihas.json create mode 100644 data/en/ajaximport.json create mode 100644 data/en/ajaxproxy.json create mode 100644 data/en/application.json create mode 100644 data/en/applicationpathcacheclear.json create mode 100644 data/en/argument.json create mode 100644 data/en/arrayremoveduplicates.json create mode 100644 data/en/associate.json create mode 100644 data/en/authenticate.json create mode 100644 data/en/break.json create mode 100644 data/en/cache.json create mode 100644 data/en/case.json create mode 100644 data/en/catch.json create mode 100644 data/en/col.json create mode 100644 data/en/collection.json create mode 100644 data/en/component.json create mode 100644 data/en/componentlistpackage.json create mode 100644 data/en/configtranslate.json create mode 100644 data/en/content.json create mode 100644 data/en/continue.json create mode 100644 data/en/cookie.json create mode 100644 data/en/createaisession.json create mode 100644 data/en/createulid.json create mode 100644 data/en/dbinfo.json create mode 100644 data/en/debugadd.json create mode 100644 data/en/defaultcase.json create mode 100644 data/en/directory.json create mode 100644 data/en/directoryinfo.json create mode 100644 data/en/document.json create mode 100644 data/en/documentitem.json create mode 100644 data/en/documentsection.json create mode 100644 data/en/dump.json create mode 100644 data/en/else.json create mode 100644 data/en/elseif.json create mode 100644 data/en/encodeforsql.json create mode 100644 data/en/error.json create mode 100644 data/en/execute.json create mode 100644 data/en/exit.json create mode 100644 data/en/extensioninfo.json create mode 100644 data/en/feed.json create mode 100644 data/en/file.json create mode 100644 data/en/fileinfo.json create mode 100644 data/en/filemodetosymbolic.json create mode 100644 data/en/filetouch.json create mode 100644 data/en/finally.json create mode 100644 data/en/findlast.json create mode 100644 data/en/findlastnocase.json create mode 100644 data/en/flush.json create mode 100644 data/en/forward.json create mode 100644 data/en/ftp.json create mode 100644 data/en/function.json create mode 100644 data/en/gatewayaction.json create mode 100644 data/en/gatewaystate.json create mode 100644 data/en/generate3deskey.json create mode 100644 data/en/generatersakeys.json create mode 100644 data/en/getcomponentstaticscope.json create mode 100644 data/en/getcontextinfo.json create mode 100644 data/en/gethttprequestheaders.json create mode 100644 data/en/getpropertyfile.json create mode 100644 data/en/getpropertystring.json create mode 100644 data/en/getsecret.json create mode 100644 data/en/getsystemproporenvvar.json create mode 100644 data/en/header.json create mode 100644 data/en/htmlbody.json create mode 100644 data/en/htmlhead.json create mode 100644 data/en/http.json create mode 100644 data/en/httpparam.json create mode 100644 data/en/if.json create mode 100644 data/en/image.json create mode 100644 data/en/imagecoderinfo.json create mode 100644 data/en/imagewritetobrowser.json create mode 100644 data/en/imap.json create mode 100644 data/en/import.json create mode 100644 data/en/include.json create mode 100644 data/en/inquiryaisession.json create mode 100644 data/en/inspecttemplates.json create mode 100644 data/en/interface.json create mode 100644 data/en/internalrequest.json create mode 100644 data/en/interruptthread.json create mode 100644 data/en/invokeargument.json create mode 100644 data/en/isflushed.json create mode 100644 data/en/iswithintransaction.json create mode 100644 data/en/ldap.json create mode 100644 data/en/listgetduplicates.json create mode 100644 data/en/listqualifiedtoarray.json create mode 100644 data/en/loadaisession.json create mode 100644 data/en/lock.json create mode 100644 data/en/logallthreads.json create mode 100644 data/en/login.json create mode 100644 data/en/loginuser.json create mode 100644 data/en/logout.json create mode 100644 data/en/loop.json create mode 100644 data/en/lslcase.json create mode 100644 data/en/lsucase.json create mode 100644 data/en/luceeaigetmetadata.json create mode 100644 data/en/luceeaihas.json create mode 100644 data/en/luceecreateaisession.json create mode 100644 data/en/luceeinquiryaisession.json create mode 100644 data/en/mail.json create mode 100644 data/en/mailparam.json create mode 100644 data/en/mailpart.json create mode 100644 data/en/markdowntohtml.json create mode 100644 data/en/maveninfo.json create mode 100644 data/en/mavenload.json create mode 100644 data/en/module.json create mode 100644 data/en/object.json create mode 100644 data/en/objectcache.json create mode 100644 data/en/output.json create mode 100644 data/en/pageencoding.json create mode 100644 data/en/param.json create mode 100644 data/en/pdf.json create mode 100644 data/en/pdfparam.json create mode 100644 data/en/pop.json create mode 100644 data/en/processingdirective.json create mode 100644 data/en/procparam.json create mode 100644 data/en/procresult.json create mode 100644 data/en/property.json create mode 100644 data/en/queryclose.json create mode 100644 data/en/querygetcellbyindex.json create mode 100644 data/en/queryisempty.json create mode 100644 data/en/queryparam.json create mode 100644 data/en/queryrenamecolumn.json create mode 100644 data/en/queryrowbyindex.json create mode 100644 data/en/queryrowdatabyindex.json create mode 100644 data/en/querytostruct.json create mode 100644 data/en/registry.json create mode 100644 data/en/rethrow.json create mode 100644 data/en/retry.json create mode 100644 data/en/return.json create mode 100644 data/en/s3addacl.json create mode 100644 data/en/s3clearbucket.json create mode 100644 data/en/s3copy.json create mode 100644 data/en/s3createbucket.json create mode 100644 data/en/s3delete.json create mode 100644 data/en/s3deletebucket.json create mode 100644 data/en/s3download.json create mode 100644 data/en/s3exists.json create mode 100644 data/en/s3generatepresignedurl.json create mode 100644 data/en/s3generateuri.json create mode 100644 data/en/s3getacl.json create mode 100644 data/en/s3getmetadata.json create mode 100644 data/en/s3getversioninfo.json create mode 100644 data/en/s3listbucket.json create mode 100644 data/en/s3listbuckets.json create mode 100644 data/en/s3move.json create mode 100644 data/en/s3read.json create mode 100644 data/en/s3readbinary.json create mode 100644 data/en/s3setacl.json create mode 100644 data/en/s3setmetadata.json create mode 100644 data/en/s3upload.json create mode 100644 data/en/s3write.json create mode 100644 data/en/sanitize.json create mode 100644 data/en/savecontent.json create mode 100644 data/en/schedule.json create mode 100644 data/en/script.json create mode 100644 data/en/search.json create mode 100644 data/en/serializeaisession.json create mode 100644 data/en/servlet.json create mode 100644 data/en/servletparam.json create mode 100644 data/en/sessioncommit.json create mode 100644 data/en/sessionexists.json create mode 100644 data/en/set.json create mode 100644 data/en/setpropertystring.json create mode 100644 data/en/setting.json create mode 100644 data/en/silent.json create mode 100644 data/en/static.json create mode 100644 data/en/stopwatch.json create mode 100644 data/en/storedproc.json create mode 100644 data/en/switch.json create mode 100644 data/en/table.json create mode 100644 data/en/thread.json create mode 100644 data/en/threaddata.json create mode 100644 data/en/threadinterrupt.json create mode 100644 data/en/timeout.json create mode 100644 data/en/timer.json create mode 100644 data/en/transaction.json create mode 100644 data/en/trimwhitespace.json create mode 100644 data/en/try.json create mode 100644 data/en/update.json create mode 100644 data/en/valueref.json create mode 100644 data/en/wddx.json create mode 100644 data/en/while.json create mode 100644 data/en/xml.json create mode 100644 data/en/zip.json create mode 100644 data/en/zipparam.json diff --git a/data/en/abort.json b/data/en/abort.json new file mode 100644 index 000000000..df0ed5bb0 --- /dev/null +++ b/data/en/abort.json @@ -0,0 +1,27 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/abort.html", + "notes": "Since 5.3, by default output from [[tag-function|functions]] are no longer buffered when `output=false` is set, as a result, an abort inside a function will no longer work.\n\nYou can re-enable this application wide using `this.bufferOutput=true` in your [[tag-application|Application.cfc]], or server wide via the Lucee Administrator, via the Output settings page." + }}, + "name": "abort", + "description": "**Stops processing of a page at the tag location.** CFML returns everything that was processed before the cfabort tag. The cfabort tag is often used with conditional logic to stop processing a page when a condition occurs.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "showerror", + "description": "The error to display when cfabort executes.\nThe error message displays in the standard CFML error page.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "Define the abort type.\n\nAllowed Values:\n\n* **request** (default): abort the entire request\n* **page**: abort the current page execution\n", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/aigetmetadata.json b/data/en/aigetmetadata.json new file mode 100644 index 000000000..17cd38b7a --- /dev/null +++ b/data/en/aigetmetadata.json @@ -0,0 +1,24 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/aigetmetadata.html"}}, + "name": "aigetmetadata", + "description": "Retrieves metadata about a configured AI endpoint. \nReturns information about the endpoint's configuration, \nand optionally detailed information about available models and associated files.", + "syntax": "aigetmetadata( name )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "name", + "description": "The name of the AI endpoint to get metadata for. Can be either:\n\n1. A direct endpoint name as configured in the Lucee Administrator\n2. A default reference (e.g., \"default:exception\") which will resolve to the configured default endpoint for that category\n3. A AI session object from which to retrieve and analyze AI endpoint metadata", + "aliases": "aiName,nameAI,session", + "type": "any", + "required": true + }, + { + "name": "detailed", + "description": "When true, includes additional detailed information:\n\n- Models: List of available models with their names, labels, descriptions, and custom settings\n- Files: For file-capable engines, lists associated files with their IDs, purposes, sizes, creation dates, and status information", + "default": "false", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/aihas.json b/data/en/aihas.json new file mode 100644 index 000000000..41c6b94b4 --- /dev/null +++ b/data/en/aihas.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/aihas.html"}}, + "name": "aihas", + "description": "Checks whether a specific AI endpoint is configured and available for use.", + "syntax": "aihas( name )", + "returns": "boolean", + "type": "function", + "params": [{ + "name": "name", + "description": "The name of the AI endpoint to check. Can be either:\n\n1. A direct endpoint name as configured in the Lucee Administrator\n2. A default reference (e.g., \"default:exception\") which will check if a default endpoint is configured for that category", + "aliases": "aiName,nameAI", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/ajaximport.json b/data/en/ajaximport.json new file mode 100644 index 000000000..6c3d139fd --- /dev/null +++ b/data/en/ajaximport.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/ajaximport.html"}}, + "name": "ajaximport", + "description": "Controls the JavaScript files that are imported for use on pages that use ColdFusion AJAX tags and features.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "csssrc", + "description": "Specifies the URL, relative to the web root, of the directory that contains the CSS files used by AJAX features", + "default": false, + "type": "string", + "required": false + }, + { + "name": "scriptsrc", + "description": "Specifies the URL, relative to the web root, of the directory that contains the JavaScript files used by Lucee.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "tags", + "description": "A comma-delimited list of tags or tag-attribute combinations for which to import the supporting JavaScript files on this page.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/ajaxproxy.json b/data/en/ajaxproxy.json new file mode 100644 index 000000000..bfb38fad2 --- /dev/null +++ b/data/en/ajaxproxy.json @@ -0,0 +1,45 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/ajaxproxy.html"}}, + "name": "ajaxproxy", + "description": "Creates a JavaScript proxy for a ColdFusion component, for use in an AJAX client. Alternatively, creates a proxy for a single CFC method, JavaScript function, or URL that is bound to one or more control attribute values.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "bind", + "description": "**(not supported)** A bind expression that specifies a CFC method, JavaScript function, or URL to call. Cannot be used with the cfc attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cfc", + "description": "the CFC for which to create a proxy. You must specify a dot-delimited path to the CFC. The path can be absolute or relative to location of the CFML page. For example, if the myCFC CFC is in the cfcs subdirectory of the Luceex page, specify cfcs.myCFC.\n\nOn UNIX based systems, the tag searches first for a file whose name or path corresponds to the specified name or path, but is in all lower case. If it does not find it, Luceex then searches for a file name or path that corresponds to the attribute value exactly, with identical character casing.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "jsclassname", + "description": "The name to use for the JavaScript proxy class.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "onerror", + "description": "The name of a JavaScript function to invoke when a bind, specified by the bind attribute fails. The function must take two arguments: an error code and an error message.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "onsuccess", + "description": "The name of a JavaScript function to invoke when a bind, specified by the bind attribute succeeds. The function must take one argument, the bind function return value. If the bind function is a CFC function, the return value is automatically converted to a JavaScript variable before being passed to the onSuccess function.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/application.json b/data/en/application.json new file mode 100644 index 000000000..d9f843604 --- /dev/null +++ b/data/en/application.json @@ -0,0 +1,660 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/application.html"}}, + "name": "application", + "description": "Defines a CFML Application and configures the properties / behavior of that Application", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "The name of your application. This name can be up to 64 characters long.\n\nRequired for application and session variables, optional for client variables.\n\nBy using a different name, i.e. based off cgi.http_host, you can run multiple, separate instances of an application using the same directory / code base.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "datasource", + "description": "alias for default datasource", + "default": false, + "type": "object", + "required": false + }, + { + "name": "defaultdatasource", + "description": "the default datasource for this environment", + "default": false, + "type": "object", + "required": false + }, + { + "name": "datasources", + "description": "A structure that contains datasources definitions.", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "logs", + "description": "A structure that contains log definitions.", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "mailservers", + "description": "Array of structs that defines the mailserver configuration. Each struct configures one mailserver. Struct keys used for smtp configuration are:\n - host (string): host name of smtp server\n - port (numeric): port number of smtp server\n - username (string): smtp username\n - password (string): smtp userpassword \n - ssl (boolean): enable secure connections via SSL.\n - tls (boolean): enables Transport Layer Security.\n - lifeTimespan (timespan): overall timeout for the connections established to the mail server.\n - idleTimespan (timespan): idle timeout for the connections established to the mail server.", + "default": false, + "type": "array", + "required": false + }, + { + "name": "caches", + "description": "A structure that contains cache definitions.", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "action", + "description": "The action to perform on the CFML application.\n\n- **create:** creates a new CFML application context and overwrites any existing application\n- **update:** updates the existing CFML application context if one exists, otherwise creates a new one\n\nThe default value is: create.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "loginstorage", + "description": "storage for the login data:\n\n- **cookie:** store login information in the Cookie scope\n- **session:** store login information in the Session scope", + "default": false, + "type": "string", + "required": false + }, + { + "name": "clientmanagement", + "description": "Yes or No. Enables client variables. Default is No.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "clientstorage", + "description": "Specifies how Lucee stores client variables:\n\n- memory: the session is only kept in memory\n- cookie: the session is stored in the client cookie\n- file (default): the session is stored in a local file\n- \"datasource-name\"|\"cache-name\": when you select a name of an available datasource or cache, the client scope will be stored in there\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "sessiontype", + "description": "Lucee provide 2 kind of sessions:\n\n- **cfml:** session handled by Lucee\n- **j2ee:** session handled by the Servlet Engine used\n\nDefault value is defined in the Lucee Web Administrator. \"j2ee\" can not use a session storage.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "sessionstorage", + "description": "Specifies how Lucee stores session variables:\n\n- **memory (default):** the session is only kept in memory\n- **cookie:** the session is stored in the client cookie\n- **file:** the session is stored in a local file\n- **\"datasource-name\"|\"cache-name\":** when you select a name of an available datasource or cache, the session scope will be stored in there", + "default": false, + "type": "string", + "required": false + }, + { + "name": "clientcluster", + "description": "If set to true, lucee uses the storage backend for the client scope as master and Lucee checks for changes in the storage backend with every request.\n\nIf set to false (default), the storage is only used as slave, lucee only initially gets the data from the storage. Ignored for storage type \"memory\".", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "sessioncluster", + "description": "if set to true, lucee uses the storage backend for the session scope as master and Lucee checks for changes in the storage backend with every request.\n\nIf set to false (default), the storage is only used as slave, lucee only initially gets the data from the storage. Ignored for storage type \"memory\".", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "setclientcookies", + "description": "Yes or No. Yes enables client cookies. Default is Yes.\n\nIf you set this attribute to\"No\", Lucee does not automatically send the CFID and CFTOKEN cookies to the client browser; you must manually code CFID and CFTOKEN on the URL for every page that uses Session or Client variables.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "cgireadonly", + "description": "if set to true, the CGI Scope is readonly.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "bufferoutput", + "description": "if set to true (default) the output written to the body of the tag is buffered and in case of an exception also outputted.\n\nif set to false the content to body is ignored and not disabled when a failure in the body of the tag occur.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "sessionmanagement", + "description": "Yes or No. Yes enables session variables. Default is No.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "sessiontimeout", + "description": "Enter the CreateTimeSpan function and values in days, hours, minutes, and seconds, separated by commas, to specify the lifespan of session variables.\n\nThe default value is specified in the Variables page of the Lucee Administrator.", + "default": false, + "type": "timespan", + "required": false + }, + { + "name": "clienttimeout", + "description": "Enter the CreateTimeSpan function and values in days, hours, minutes, and seconds, separated by commas, to specify the lifespan of client variables.\n\nThe default value is specified in the Variables page of the Lucee Administrator.", + "default": false, + "type": "timespan", + "required": false + }, + { + "name": "applicationtimeout", + "description": "Sets the lifespan of variables that live in the application scope. Accepts a TimeSpan created using the `createTimeSpan()` function.\n\nThe default value is defined on the Variables page of the Lucee Administrator.\n", + "default": false, + "type": "timespan", + "required": false + }, + { + "name": "requesttimeout", + "description": "Sets the amount of time Lucee will wait for a request to finish before a request timeout will be raised. This means that the execution of the request will be stopped.", + "default": false, + "type": "timespan", + "required": false + }, + { + "name": "setdomaincookies", + "description": "Yes or No.\n\nSets the CFID and CFTOKEN cookies for a domain, not just a single host.\n\nApplications that are running on clusters must set this value to Yes.\n\nThe default is No.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "scriptprotect", + "description": "Specifies whether to protect variables from cross-site scripting attacks.\n\nYou may specify the string value also as a comma separated list to fine tune protection.\n\n- **none:** disables cross-site scripting protection\n- **all (default):** applies cross-site scripting protection to cgi, url, form and cookie scope variables\n- **cgi:** applies protection to cgi scope variables only\n- **url:** applies protection to url scope variables only\n- **form:** applies protection to form scope variables only\n- **cookie:** applies protection to cookie scope variables only\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxy", + "description": "general proxy that should be used for all connections with the following format:\n\n{server:\"localhost\", port:12345, username:\"susi\", password: \"sorglos\"}", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "mappings", + "description": "A structure that contains mappings. Each element in the structure consists of a key and a value.\n\nThe logical path is the key and the absolute path is the value.\n\n[[cookbook-filesystem-mapping-define-mapping]]", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "functionpaths", + "description": "Array or String list of paths where you have your functions.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "customtagpaths", + "description": "Contains custom tag paths.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "componentpaths", + "description": "Contains component paths.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "securejson", + "description": "A Boolean value that specifies whether to add a security prefix in front of the value that a function returns in JSON-format\nin response to a remote call.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "wstype", + "description": "webservice type used, only the following is supported\n\n- **Axis1 (default):** The Apache Axis 1 implementation is used\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "typechecking", + "description": "If disabled, Lucee ignores type definitions with function arguments and return values", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "compression", + "description": "Enable compression (GZip) for the Lucee Response stream for text-based responses when supported by the client (Web Browser).", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "suppressremotecomponentcontent", + "description": "Suppress content written to response stream when a Component is invoked remotely. Only works if the content was not flushed before.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "securejsonprefix", + "description": "The security prefix to put in front of the value that a function returns in JSON-format in response to a remote call if the secureJSON setting is true.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "localmode", + "description": "Defines how the local scope of a function is invoked when a variable with no scope definition is used (default value set in the lucee administrator).\n\n- **modern:** (alias true) new unscoped variables will be set to the Local Scope\n- **classic (CFML standard):** (alias false) new unscoped variables will be set to the Variables Scope", + "default": false, + "type": "string", + "required": false + }, + { + "name": "maillistener", + "description": "Defines a mail listeners for cfmail\n\nSee the [[cookbook-mail-listeners]] for details", + "default": false, + "type": "any", + "required": false + }, + { + "name": "querylistener", + "description": "Defines a query listeners for cfquery.\n\nSee the [[query-listeners]] for details\n", + "default": false, + "type": "any", + "required": false + }, + { + "name": "serializationsettings", + "description": "", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "tag", + "description": "tags/attributes default value in the following structure:\n\n {location:{addtoken=false}}\n", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "ormenabled", + "description": "Specifies whether ORM should be enabled for the current application context.\n\nThe default is false.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "ormsettings", + "description": "A struct that defines all the ORM settings, the following keys are supported:\n\n- **autogenmap(default:true; autogenmap=false is not supported yet):** Specifies whether Lucee should automatically generate mapping for the persistent CFCs. If autogenmap=false, mapping should be provided in the form of \"{cfc-name}.cfc.hbm.xml\" files.\n- **automanageSession(default:true; not supported yet):** Lets you specify if Lucee must manage Hibernate session automatically. If enabled: Lucee manages the session completely. That is, it decides when to flush the session, when to clear the session, and when to close the session. If disabled: The application is responsible for managing flushing, clearing, or closing of the session. The only exception is (in the case of transaction), when the transaction commits, the application flushes the session. Lucee closes the ORM session at the end of request irrespective of this flag being enabled or disabled.\n- **cacheconfig:** Specifies the location of the configuration file that should be used by the secondary cache provider.This setting is used only when secondarycacheenabled=true.\n- **cacheprovider:** Specifies the cache provider that should be used by ORM as secondary cache.\n- **catalog:** Specifies the default Catalog that should be used by ORM.\n- **cfclocation:** Specifies the directory (or array of directories) that should be used by Lucee to search for persistent CFCs to generate the mapping. If cfclocation is set, Lucee looks at only the paths specified in it. If it is not set, Lucee looks at the application directory, its sub-directories, and its mapped directories to search for persistent CFCs.\n- **datasource:** Specifies the data source that should be used by ORM. If it is not specified here, then the data source specified for the application is picked up.\n- **dbcreate(default:none):** Hibernate can automatically create the tables for your application in the database. dbCreate takes the following **values:**\n\n\t- **update:** Setting this value creates the table if it does not exist or update the table if it exists.\n\n\t- **dropcreate:** Setting this value drops the table if it exists and then creates it.\n\n\t- **none:** Setting this value does not change anything in the database schema.\n- **dialect:** Specifies the dialect.Lucee supports the following dialects: [Cache 2007.1, Cache71, Cache 2007.1, DB2, DB2/390, DB2/400, DB2390, DB2400, DB2AS400, DB2OS390, DataDirectOracle9, Derby, Firebird, FrontBase, H2, H2DB, HSQL, HSQLDB, Informix, Ingres, Interbase, JDataStore, MSSQL, Mckoi, MckoiSQL, MicrosoftSQLServer, Mimer, MimerSQL, MySQL, MySQL/InnoDB, MySQL/MyISAM, MySQL5, MySQL5/InnoDB, MySQL5InnoDB, MySQLInnoDB, MySQLMyISAM, MySQLwithInnoDB, MySQLwithMyISAM, Oracle, Oracle10g, Oracle8i, Oracle9, Oracle9i, Pointbase, PostgreSQL, PostgresPlus, Progress, SAPDB, SQLServer, Sybase, Sybase11, SybaseASE15, SybaseAnywhere, com.ddtek.jdbc.db2.DB2Driver, com.microsoft.jdbc.sqlserver.SQLServerDriver, oracle.jdbc.driver.OracleDriver, org.firebirdsql.jdbc.FBDriver, org.gjt.mm.mysql.Driver, org.h2.Driver, org.hsqldb.jdbcDriver, org.postgresql.Driver]\n- **eventHandling(default:false):** Specifies whether ORM Event callbacks should be given.\n- **flushatrequestend(default:true):** Specifies whether ormflush should be called automatically at request end. If flushatrequestend is false, ormflush is not called automatically at request end.\n- **logSQL(default:false):** Specifies whether the SQL queries that are executed by ORM will be logged. If LogSQL=true, the SQL queries are logged to the console.\n- **ormconfig:** The Hibernate configuration file. This file contains various configuration parameters like, dialect, cache settings, and mapping files that are required for the application. For more details, see . The settings defined in the ormsettings override the settings defined in the Hibernate Configuration XML file.The connection information in the Hibernate Configuration XML file is however ignored because Lucee uses its own connection pool. You will need to use this only when you need to use a hibernate setting that is not available using ormsetting.\n- **savemapping(default:false):** Specifies whether the generated Hibernate mapping file has to be saved to disc. If you set the value to true, the Hibernate mapping XML file is saved with the filename \"CFC name\".hbm.xml in the same directory as the CFC. If any value of savemapping is specified in CFC, it will override the value specified in the ormsetting.\n- **schema:** Specifies the default Schema that should be used by ORM.\n- **secondarycacheenabled(default:false):** Specifies whether secondary caching should be enabled\n- **skipCFCWithError(default:false;not implemented yet):** Lets you specify if Lucee must skip the CFCs that have errors. If set to true, Lucee ignores the CFCs that have errors.\n- **sqlscript:** Path to the SQL script file that gets executed after ORM is initialized. This applies if dbcreate is set to dropcreate. This must be the absolute file path or the path relative to the application.The SQL script file lets you populate the tables before the application is accessed.\n- **useDBForMapping(default:true):** Specifies whether the database has to be inspected to identify the missing information required to generate the Hibernate mapping. The database is inspected to get the column data type, primary key and foreign key information.", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "s3", + "description": "A struct that defines default S3 settings, this settings can be overwritten as part of the S3 file path, the following keys are supported:\n\n- **accessKeyId:** S3 access key id\n- **awsSecretKey:** AWS (Amazon Web Service) Secret Key\n- **defaultLocation(default:us):** region for the bucket, possible values are [eu,us,us-west]\n- **host(default:\"s3.amazonaws.com\"):** hostname of the service", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "ftp", + "description": "A struct that defines default ftp settings, this settings can be overwritten as part of the ftp file path, the following keys are supported:\n\n- **username:** username to access the ftp server\n- **password:** password to access the ftp server\n- **port:** port of the FTP server\n- **host**: hostname of the FTP server (lucee.org)", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "triggerdatamember", + "description": "If there is no accessible data member (property, element of the this scope) inside a component, Lucee searches for available matching "getters" or "setters" for the requested property.\n\nThe following example should clarify this behaviour.\n\n"somevar = myComponent.propertyName".\n\nIf "myComponent" has no accessible data member named "propertyName",\n\nLucee searches for a function member (method) named "getPropertyName".", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "invokeimplicitaccessor", + "description": "An alias for `triggerDataMember`\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "cacheobject", + "description": "name of the cache used for object caching in this context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachefunction", + "description": "name of the cache used for function caching in this context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachequery", + "description": "name of the cache used for query caching in this context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachetemplate", + "description": "name of the cache used for template caching in this context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cacheresource", + "description": "name of the cache used to store data from ram resource in this context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cacheinclude", + "description": "name of the cache used to store data from an include", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachehttp", + "description": "name of the cache used to store data from a http tag", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachefile", + "description": "name of the cache used to store data from file operations", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachewebservice", + "description": "name of the cache used to store data from webservice calls", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "onmissingtemplate", + "description": "closure/udf executed when the requested template does not exist", + "default": false, + "type": "object", + "required": false + }, + { + "name": "locale", + "description": "Sets the country/language locale for CFML processing.\n\nThe locale value determines the default format of date, time, number, and currency values, according to language and regional conventions.", + "default": false, + "type": "locale", + "required": false + }, + { + "name": "timezone", + "description": "change the timezone definition for the current application context.", + "default": false, + "type": "timezone", + "required": false + }, + { + "name": "webcharset", + "description": "character set used for output streams, form-, url-, and cgi scope variables and reading/writing the header", + "default": false, + "type": "String", + "required": false + }, + { + "name": "resourcecharset", + "description": "character set used for reading from/writing to various resources", + "default": false, + "type": "String", + "required": false + }, + { + "name": "scopecascading", + "description": "Depending on this setting Lucee scans certain scopes to find a variable called from the CFML source. This will only happen, when the variable is called without a scope. (Example: #myVar# instead of #variables.myVar#), the following values are supported:\n\n- **strict:** scans only the variables scope\n- **small:** scans the scopes variables,url,form\n- **standard:** scans the scopes variables,cgi,url,form,cookie", + "default": false, + "type": "String", + "required": false + }, + { + "name": "searchimplicitscopes", + "description": "alias to the attribute \"scopecascading\", takes a boolean value where true is equal to \"standard\" and false is equal to \"strict\" scope cascading mode.\n\nFor details see the description for the attribute \"scopecascading\".\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "searchresults", + "description": "When a variable has no scope defined (Example: #myVar# instead of #variables.myVar#), Lucee will also search available resultsets if this is set to true.", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "authcookie", + "description": "cfauthorization cookie behaviour", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "sessioncookie", + "description": "A struct which defines session cookie behaviour; the following keys are supported:\n\n- **httpOnly (boolean):** Specifies if the session cookies (CFID/CFTOKEN) should have the HTTPOnly cookie flag set. This prevents the cookie value from being read from JavaScript.\n- **secure (boolean):** Specifies if the session cookies (CFID/CFTOKEN) should have the secure cookie flag set. When true the cookies are only sent over a secure transport (eg HTTPS).\n- **domain (string):** Specifies the cookie domain used in the session cookies (CFID/CFTOKEN).\n- **timeout (string):** Specifies the expires value of the session cookies (CFID/CFTOKEN), in days. Set to -1 for browser session cookies.\n- **sameSite (string):** Specifies if the cookies should be restricted to a first-party or same-site context. Possible values for sameSite are `lax | strict | none`\n", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "enablenullsupport", + "description": "", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "nullsupport", + "description": "enable or disable full null support", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "precisemath", + "description": "If set to true Lucee increases memory size for arithmetic operations and numbers. \n\t\t\tThis improves the accuracy of floating point calculations.", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "psq", + "description": "preserve single quote in injected variables into cfquery.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "variableusage", + "description": "how to handle variable usage within cfquery,\n\npossible values are\n\n- ignore\n- warn\n- error", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachedafter", + "description": "set the timespan for the attribute \"cachedAfter\" from tag \"query\".", + "default": false, + "type": "timespan", + "required": false + }, + { + "name": "blockedextforfileupload", + "description": "A comma separated list of file extensions that will be blocked for File Upload operation", + "default": false, + "type": "string", + "required": false + }, + { + "name": "javasettings", + "description": "A struct that enables loading of application-specific Java libraries from a custom path. The following keys are supported:\n\n- **loadPaths:** An array of paths, or comma delimitered list of jar files, or directories containing jar files. This or Bundles is required.\n- **bundles:** Any array of paths, or comma delimitered list of OSGI jar files, or directories containing OSGI jar files. This or LoadPaths is required.\n- **loadCFMLClassPath (default:false):** Indicates whether underlying Lucee classes should be loaded.\n- **reloadOnChange (default:false):** Indicates if loaded Java libraries should be watched and reloaded if they change, without needing to restart the server.\n- **watchInterval (default:60):** The interval, in seconds, for checking the loaded Java libraries for changes. Only applicable if *reloadOnChange* is true.\n- **watchExtensions (default:\"class,jar\"):** A list of the file extensions to monitor for changes.\n", + "minimum_version": "str", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "xmlfeatures", + "description": "Allows to set XML Features to prevent XXE attacks\n\n- disallowDoctypeDecl (true / false)\n- externalGeneralEntities (true/false)\n- secure (true/false)\n", + "minimum_version": "str", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "regex", + "description": "A struct containing the configuration for regular expressions\n\nATM only the key \"engine\" is supported\n\nEngines:\n\n- **perl:** Use perl as regex engine\n- **java:** Use java as regex engine\n\ni.e. `{engine: \"perl\"}`\n\n``` this.useJavaAsRegexEngine = true; ``` also works\n", + "minimum_version": "any", + "default": false, + "type": "any", + "required": false + }, + { + "name": "sameformfieldsasarray", + "description": "Default False\n\t\t\tWhen true, form fields with the same name will be combined into an array.\n\t\t\tThis only works via Application.cfc", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "sameurlfieldsasarray", + "description": "Default False\n\t\t\tWhen true, url fields/parameters with the same name will be combined into an array.\n\t\t\tThis only works via Application.cfc", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "showdoc", + "description": "Show documentation output at the end of the webpage or not.", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "showmetric", + "description": "Show metric output at the end of the webpage or not.", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "showdebug", + "description": "Show debug output at the end of the webpage or not.", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingdatabase", + "description": "Log debugging information from the queries in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingexception", + "description": "Log debugging information from the exceptions in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingdump", + "description": "Log debugging information from the dump tag in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingtracing", + "description": "Log debugging information from the trace tag in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingtimer", + "description": "Log debugging information from the timer tag in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingimplicitaccess", + "description": "Log debugging information about unscoped variables accessed in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingqueryusage", + "description": "Log debugging information about which columns in queries are used the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingthread", + "description": "Log debugging information about threads used in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "debuggingtemplate", + "description": "Log debugging information about templates used in the request", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/applicationpathcacheclear.json b/data/en/applicationpathcacheclear.json new file mode 100644 index 000000000..b3d16eb59 --- /dev/null +++ b/data/en/applicationpathcacheclear.json @@ -0,0 +1,12 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/applicationpathcacheclear.html", + "minimum_version": "5.3" + }}, + "name": "applicationpathcacheclear", + "description": "flush the application.[cfc|cfm] path cache", + "syntax": "applicationpathcacheclear( )", + "returns": "void", + "type": "function", + "params": [] +} \ No newline at end of file diff --git a/data/en/argument.json b/data/en/argument.json new file mode 100644 index 000000000..3428c8d02 --- /dev/null +++ b/data/en/argument.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/argument.html"}}, + "name": "argument", + "description": "Allows subtag data to be saved with the base tag. Applies only to custom tags.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "The name of the argument", + "default": false, + "type": "string", + "required": true + }, + { + "name": "type", + "description": "The type of the argument\n\n- array\n- binary\n- boolean\n- date\n- guid\n- numeric\n- query\n- string\n- struct\n- uuid\n- variableName\n- component\n- componentName\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "required", + "description": "is argument required or not", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "default", + "description": "default value of the argument", + "default": false, + "type": "any", + "required": false + }, + { + "name": "displayname", + "description": "name to display (only used by components)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "hint", + "description": "hint to the argument (only used by components)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "passby", + "description": "should the argument passed as reference (default) or as a value", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/arrayremoveduplicates.json b/data/en/arrayremoveduplicates.json new file mode 100644 index 000000000..f984e1a1f --- /dev/null +++ b/data/en/arrayremoveduplicates.json @@ -0,0 +1,25 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/arrayremoveduplicates.html", + "minimum_version": "6.0" + }}, + "name": "arrayremoveduplicates", + "description": "Removes duplicate values from array.", + "syntax": "arrayremoveduplicates( array )", + "returns": "array", + "type": "function", + "params": [ + { + "name": "array", + "description": "A array to Removes duplicate", + "type": "array", + "required": true + }, + { + "name": "ignoreCase", + "description": "if set to true, the duplicate value will not be case sensitive", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/associate.json b/data/en/associate.json new file mode 100644 index 000000000..0180c85a8 --- /dev/null +++ b/data/en/associate.json @@ -0,0 +1,24 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/associate.html"}}, + "name": "associate", + "description": "Allows subtag data to be saved with the base tag. Applies only to custom tags.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "basetag", + "description": "The name of the base tag.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "datacollection", + "description": "The name of the structure in which the base tag stores subtag data.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/authenticate.json b/data/en/authenticate.json new file mode 100644 index 000000000..610b038a2 --- /dev/null +++ b/data/en/authenticate.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/authenticate.html"}}, + "name": "authenticate", + "description": "Authenticates a user, setting a security context for the application.\nFor more information, see the descriptions of IsAuthenticated and AuthenticatedContext.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/break.json b/data/en/break.json new file mode 100644 index 000000000..16c5efb54 --- /dev/null +++ b/data/en/break.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/break.html"}}, + "name": "break", + "description": "Used to break out of a cfloop,cfwhile or cfforeach.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "label", + "description": "used to address a specific loop instead of the nearest one.", + "default": false, + "type": "string", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/cache.json b/data/en/cache.json new file mode 100644 index 000000000..9dfe24fef --- /dev/null +++ b/data/en/cache.json @@ -0,0 +1,136 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/cache.html"}}, + "name": "cache", + "description": "Speeds up page rendering when dynamic content ", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "- cache (default): server-side and client-side template caching.\n- flush: refresh cached pages (template caching).\n- clientcache: browser-side caching only. To cache a personalized page, use this option.\n- servercache: server-side caching only. Not recommended.\n- optimal: same as \"cache\".\n- content: same as cache, but cache only the body of the tag, not the complete template (template caching).\n- put: adds a key value pair to object cache (see function cachePut for more details)\n- get: gets value matching given key from object cache (see function cacheGet for more details)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "key", + "description": "key to access cache", + "default": false, + "type": "string", + "required": false + }, + { + "name": "id", + "description": "Id of the cached object", + "default": false, + "type": "any", + "required": false + }, + { + "name": "throwonerror", + "description": "A Boolean value specifying whether t throw an error if the flush action encounters an error.\n\nOtherwise the action does not generate an error if it fails.\n\nIf this attribute is true you can handle the error in a cfcatch block, for example, if a specified id value is invalid", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "name", + "description": "name of return variable, valid with action=\"get\"", + "default": false, + "type": "string", + "required": false + }, + { + "name": "metadata", + "description": "Name of the struct variable", + "default": false, + "type": "string", + "required": false + }, + { + "name": "value", + "description": "For action=\"set\", object which needs to be stored", + "default": false, + "type": "any", + "required": false + }, + { + "name": "cachename", + "description": "definition of the cache used by name, when not set the \"default Object Cache\" defined in Lucee Administrator is used instead.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "username", + "description": "When required for basic authentication, a valid username.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "When required for basic authentication, a valid password.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "protocol", + "description": "Specifies the protocol used to create pages from cache. Either http:// or https://. The default\nis http://.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timespan", + "description": "The interval until the item is flushed from the cache.\n\nA decimal number of days, for example:\n\n- .25, for one-fourth day (6 hours)\n- 1, for one day\n- 1.5, for one and one half days\n\nA return value from the CreateTimeSpan function, for example, \"#CreateTimeSpan(0,6,0,0)#\".\n\nThe default action is to flush the item when it is idle for the time specified by the idleTime attribute, or cfcache action=\"flush\" executes.", + "default": false, + "type": "timespan", + "required": false + }, + { + "name": "idletime", + "description": "Flushes the cached item if it is not accessed for the specified time span:\nA decimal number of days, for example:\n\n- .25, for one-fourth day (6 hours)\n- 1, for one day\n- 1.5, for one and one half days\n\nA return value from the CreateTimeSpan function, for example, \"#CreateTimeSpan(0,6,0,0)#\".", + "default": false, + "type": "timespan", + "required": false + }, + { + "name": "directory", + "description": "Absolute path of cache directory.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachedirectory", + "description": "Absolute path of cache directory (alias for directory).", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "This attribute has been deprecated and is non-functional.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "expireurl", + "description": "A URL reference.\n\nCan include wildcards, for example: \"*/view.cfm?id=*\".\n\nLucee flushes, from the cache, pages that match the specified URL or pattern.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "port", + "description": "Port number of the web server from which the URL for the cached page is requested.\n\nIn the internal call from cfcache to cfhttp, Lucee resolves each URL variable in the page; this ensures that links in the page remain functional.", + "default": false, + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/case.json b/data/en/case.json new file mode 100644 index 000000000..0d208ab8f --- /dev/null +++ b/data/en/case.json @@ -0,0 +1,24 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/case.html"}}, + "name": "case", + "description": "Handle one case of a cfswitch", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "value", + "description": "One or more constant values that cfswitch compares to the specified expression case-insensitive comparison.\n\nIf a value matches the expression, cfswitch executes the code between the cfcase start and end tags.\n\nSeparate multiple values with a comma or other delimiter, as specified in the delimiters parameter.\n\nDuplicate value attributes are not allowed and causes a runtime error.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "delimiters", + "description": "Specifies the character that separates multiple entries in a list of values. You can specify multiple delimiter characters and you can use any of them to separate the values to be matched. Delimiters can only be used in the tag syntax.\n\nDefault delimiter: ,\n\nNote: in [[tag-script]], delimitered values are not supported for case statements. Use an individual case statement for each value.\n", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/catch.json b/data/en/catch.json new file mode 100644 index 000000000..83c8db37c --- /dev/null +++ b/data/en/catch.json @@ -0,0 +1,24 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/catch.html"}}, + "name": "catch", + "description": "Used only inside a cftry, the cfcatch tag catches and process exceptions.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "The name for the struct containing the exception information\n\nby default it is cfcatch (in Lucee, the cfcatch variable will also be populated)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "Type of catch, default:Any", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/col.json b/data/en/col.json new file mode 100644 index 000000000..214ad6ecb --- /dev/null +++ b/data/en/col.json @@ -0,0 +1,38 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/col.html"}}, + "name": "col", + "description": "Defines table column header, width, alignment, and text. Used only inside a cftable.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "header", + "description": "The text for the column's header.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "width", + "description": "The width of the column in characters (the default is 20). If the length of the data displayed exceeds the width value,\nthe data is truncated to fit.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "align", + "description": "Column alignment, Left, Right, or Center.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "text", + "description": "Double-quote delimited text that determines what displays in the column. The rules for the text\nattribute are identical to the rules for cfoutput sections; it can consist of a combination of\nliteral text, HTML tags, and query record set field references. You can embed hyperlinks, image\nreferences, and input controls in columns.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/collection.json b/data/en/collection.json new file mode 100644 index 000000000..51349181b --- /dev/null +++ b/data/en/collection.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/collection.html"}}, + "name": "collection", + "description": "Allows you to create and administer Search collections.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "engine", + "description": "This attribute only exists for compatibility reasons to other CFML engines, the attribute is completely ignored by Lucee.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "categories", + "description": "Used only for creating a collection", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "action", + "description": "Specifies the action to perform.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "collection", + "description": "Specifies a collection name or an alias if action = \"map\"", + "default": false, + "type": "string", + "required": false + }, + { + "name": "path", + "description": "Absolute path to a Lucene collection.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "language", + "description": "language the collection is based on:\n\npossible values are: english, german, russian, dutch, french, italian, norwegian, portuguese, spanish, brazilian, chinese, greek, thai, danish, japanese, norwegian, korean", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "Name for the query results returned by the list action.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/component.json b/data/en/component.json new file mode 100644 index 000000000..2baa91ff5 --- /dev/null +++ b/data/en/component.json @@ -0,0 +1,136 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/component.html"}}, + "name": "component", + "description": "Creates and defines a component object", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "accessors", + "description": "If set to true, enables implicit getters and setters for the component's properties. For persistent CFCs, accessors are always enabled.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "synchronized", + "description": "If set to true all calls to an instance of a component are synchronized. This setting allows a method to be executed only by one single thread at a time.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "persistent", + "description": "Specifies CFC is persistent or not", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "extends", + "description": "Name of parent component from which to inherit methods and properties.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "implements", + "description": "Lists the interfaces that the component implements, specifying the set of functions that the component must provide.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "modifier", + "description": "Defines the type of component: `none` for a regular component, `abstract` for a component that cannot be instantiated directly and must be extended, or `final` for a component that cannot be extended by other components.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "displayname", + "description": "A string to be displayed when using introspection to show\ninformation about the CFC. The information appears on the\nheading, following the component name.\nIf the style attribute is set to document, the displayname\nattribute is used as the name of the service element in the WSDL.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "hint", + "description": "Text that displays when you use introspection to show information about the CFC. The hint attribute value appears below the component name heading. Use this attribute to describe the purpose of the component.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "output", + "description": "- true: permits component method output\n- false: suppresses component method output", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "style", + "description": "Specifies whether a CFC used for web services uses RPC-encoded style or document-literal style", + "default": false, + "type": "string", + "required": false + }, + { + "name": "namespace", + "description": "Specifies the namespace used in the WSDL when\nusing the CFC as a document-literal style web service.\nIf you don't specify this attribute, Lucee\nderives the namespace from the CFC class name.\nThis attribute applies only when style=\"document\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "serviceportname", + "description": "Specifies the name of the port element in the WSDL.\nThis attribute applies only when style=\"document\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "serviceaddress", + "description": "Specifies the SOAP URL of the web service. If you don't specify this attribute, Lucee uses the URL of the CFC in the WSDL service description.\nUse this attribute to specify the protocol, for example, by specifying a URL that starts with https://. This attribute applies only for web services.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "porttypename", + "description": "Specifies the name of the porttype element in the WSDL.\nThis attribute applies only when style=\"document\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "bindingname", + "description": "Specifies the name of the binding element in the WSDL.\nThis attribute applies only when style=\"document\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "wsdlfile", + "description": "A properly formatted WSDL file to be used instead of\nWSDL generated by Lucee.\nThis attribute applies only when style=\"document\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "alias", + "description": "Defines an alternative name or alias for the component, providing flexibility in referencing the component in different contexts.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "mappedsuperclass", + "description": "Indicates whether the component acts as a mapped superclass. A mapped superclass serves as a base class for other components to extend but does not itself represent a database entity.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/componentlistpackage.json b/data/en/componentlistpackage.json new file mode 100644 index 000000000..197e2bffd --- /dev/null +++ b/data/en/componentlistpackage.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/componentlistpackage.html"}}, + "name": "componentlistpackage", + "description": "List all components in a certain package, throws an application exception if package does not exist.", + "syntax": "componentlistpackage( package )", + "returns": "array", + "type": "function", + "params": [{ + "name": "package", + "description": "name of the package to list", + "aliases": "packageName,name", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/configtranslate.json b/data/en/configtranslate.json new file mode 100644 index 000000000..bfe70874a --- /dev/null +++ b/data/en/configtranslate.json @@ -0,0 +1,46 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/configtranslate.html", + "minimum_version": "6.0" + }}, + "name": "configtranslate", + "description": "translate an old Lucee XML configuration to the new CFConfig.json configuration", + "syntax": "configtranslate( source )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "source", + "description": "Path to the Lucee XML file (lucee-server.xml or lucee-web.xml.cfm) file or the data itself as a String.", + "aliases": "data,input", + "type": "string", + "required": true + }, + { + "name": "target", + "description": "Path to the Lucee XML file (lucee-server.xml or lucee-web.xml.cfm) file or the data itself as a String.", + "aliases": "output", + "type": "string", + "required": false + }, + { + "name": "type", + "description": "Config Context to manipulate, server or web context.", + "default": "server", + "type": "string", + "required": false + }, + { + "name": "mode", + "description": "Only used when type is set to [server], should be the resulting json set for single or multi mode.", + "type": "string", + "required": false + }, + { + "name": "charset", + "description": "charset to use to read the XML file, if not defined, Lucee will use the default resource charset.", + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/content.json b/data/en/content.json new file mode 100644 index 000000000..9d4e47dca --- /dev/null +++ b/data/en/content.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/content.html"}}, + "name": "content", + "description": "Defines the MIME type returned by the current page. Optionally, lets you specify the name of a file\nto be returned with the page.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "type", + "description": "Defines the File/ MIME content type returned by the current page.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "deletefile", + "description": "Yes or No. Yes deletes the file after the download operation. Defaults to No.\n\nThis attribute applies only if you specify a file with the file attribute.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "range", + "description": "Yes or No. Yes allows download ranges, no forbids download range, default let it open for client.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "file", + "description": "The full path to the file that should be sent to the client\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "content", + "description": "this attribute is deprecated, use variable instead", + "default": false, + "type": "binary", + "required": false + }, + { + "name": "variable", + "description": "the variable name to the content to output as binary", + "default": false, + "type": "any", + "required": false + }, + { + "name": "reset", + "description": "Yes or No. Yes discards output that precedes the call to cfcontent.\n\nNo preserves the output that precedes the call. Defaults to Yes.\n\nThe reset and file attributes are mutually exclusive.\n\nIf you specify a file, the reset attribute has no effect.\n", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/continue.json b/data/en/continue.json new file mode 100644 index 000000000..23371a8a3 --- /dev/null +++ b/data/en/continue.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/continue.html"}}, + "name": "continue", + "description": "Used within a cfloop tag. Returns processing to the top of a loop.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "label", + "description": "used to address a specific loop instead of the nearest one.", + "default": false, + "type": "string", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/cookie.json b/data/en/cookie.json new file mode 100644 index 000000000..514549b14 --- /dev/null +++ b/data/en/cookie.json @@ -0,0 +1,89 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/cookie.html"}}, + "name": "cookie", + "description": "Defines cookie variables, including expiration and security options.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "The name of the cookie variable.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "value", + "description": "The value assigned to the cookie variable.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "expires", + "description": "Schedules the expiration of a cookie variable.\n\nCan be specified:\n\n- as a date (as in, 10/09/97)\n- number of days (as in, 10, 100)\n- \"Now\"\n- \"Never\"\n\nUsing Now effectively deletes the cookie from the client browser.\n", + "default": false, + "type": "object", + "required": false + }, + { + "name": "secure", + "description": "Yes or No. Specifies that the variable must transmit securely. If the browser does not support\nSecure Socket Layer (SSL) security, the cookie is not sent.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "path", + "description": "URL, within a domain, to which the cookie applies;\ntypically a directory. Only pages in this path can use the\ncookie. By default, all pages on the server that set the\ncookie can access the cookie.\n\npath = \"/services/login\"", + "default": false, + "type": "string", + "required": false + }, + { + "name": "domain", + "description": "Domain in which cookie is valid and to which cookie content\ncan be sent from the user's system. By default, the cookie\nis only available to the server that set it. Use this\nattribute to make the cookie available to other servers.\n\nMust start with a period. If the value is a subdomain, the\nvalid domain is all domain names that end with this string.\nThis attribute sets the available subdomains on the site\nupon which the cookie can be used.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "httponly", + "description": "If HttpOnly is set to true, this cookie is marked as HttpOnly, by adding the HttpOnly attribute to it.\n\nHttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "preservecase", + "description": "if set to true Lucee keep the original case for the name, otherwise the name is converted to a upper case string", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "encodevalue", + "description": "if set to true, Lucee url encodes the given name and value if necessary.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "samesite", + "description": "It will help to prevent Cross-Site Request Forgeries.\nEnabling this attribute on the cookie will instruct the browser to afford this cookie certain protections.\n\nValues:\n\n - strict\n - lax\n - none\n", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "partitioned", + "description": "Used to isolate third party cookies, requires path=\"/\" and secure=\"true\".", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/createaisession.json b/data/en/createaisession.json new file mode 100644 index 000000000..6a845d9d2 --- /dev/null +++ b/data/en/createaisession.json @@ -0,0 +1,39 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/createaisession.html"}}, + "name": "createaisession", + "description": "Creates a new AI session for interaction with Large Language Models (LLMs). \nThe session maintains conversation history and context between interactions. \nEach session can be configured with different parameters to optimize for specific use cases like code analysis, content generation, or data processing.\nCommon usage patterns:\n- Exception analysis and debugging assistance\n- Code documentation generation\n- Query optimization suggestions\n- Security review assistance\n- Performance optimization recommendations\nThe session persists until explicitly terminated or the application restarts.", + "syntax": "createaisession( name )", + "returns": "object", + "type": "function", + "params": [ + { + "name": "name", + "description": "Specifies which AI endpoint configuration to use. Can be provided in two formats:\n\n1. Direct endpoint name:\n\nThe name of an endpoint as defined in the Lucee Administrator (similar to how datasource names work)\n\n2. Default reference:\n\nUsing the format \"default:category\" to use the endpoint configured as the default for that specific category in the Lucee Administrator.\n\nCurrently supported default categories:\n\n- exception: For exception analysis\n- documentation: For documentation tasks\n\nThe endpoint configurations and their default category assignments are managed in the Lucee Administrator.", + "aliases": "aiName,nameAI", + "type": "string", + "required": true + }, + { + "name": "systemMessage", + "description": "Initial instruction set that defines the AI's behavior and expertise for this session. This message sets the context and rules for all subsequent interactions.\n\nBest practices:\n\n- Be specific about the AI's role and expertise\n- Define output format requirements clearly\n- Include any necessary constraints or rules\n- Specify error handling preferences\n- Define response structure expectations\n\nThe system message persists throughout the session and influences all responses.", + "aliases": "initalMesssage,message", + "type": "string", + "required": false + }, + { + "name": "limit", + "description": "Maximum number of question-answer pairs to keep in the conversation history. Once reached, older messages will be removed.\n\nConsider:\n\n- Higher limits provide more context but consume more memory\n- Lower limits are more memory efficient but may lose important context\n- For complex analysis tasks, consider limits of 10-20\n- For simple Q&A, limits of 5-10 may suffice", + "default": "50", + "aliases": "conversationHistoryLimit", + "type": "numeric", + "required": false + }, + { + "name": "temperature", + "description": "Controls response randomness (0.0 to 1.0). Lower values make responses more focused and deterministic, higher values make them more creative and varied.\n\nRecommended settings:\n\n- 0.0-0.3: Technical analysis, debugging, code review\n- 0.3-0.5: Documentation generation, error explanations\n- 0.5-0.7: General purpose interactions\n- 0.7-1.0: Creative content generation\n\nFor exception analysis and debugging, lower temperatures (0.2-0.3) are recommended for more consistent and precise responses.", + "default": "0.7", + "type": "numeric", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/createulid.json b/data/en/createulid.json new file mode 100644 index 000000000..254306012 --- /dev/null +++ b/data/en/createulid.json @@ -0,0 +1,34 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/createulid.html", + "minimum_version": "6.0" + }}, + "name": "createulid", + "description": "Generates a ULID (Universally Unique Lexicographically Sortable Identifier)", + "syntax": "createulid( )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "type", + "description": "Specifies the generation mode of the ULID. If not defined, a standard ULID is generated.\n\n- `monotonic` ensures ULIDs increase monotonically, suitable for ensuring order in rapid generation scenarios. \n- `hash` mode generates a ULID based on hashing the provided inputs, useful for creating deterministic identifiers.", + "default": "", + "type": "string", + "required": false + }, + { + "name": "input1", + "description": "Used in conjunction with the `hash` type, this numeric input contributes to the generation of a deterministic ULID by influencing its random component.\n\nonly used for hash", + "default": "", + "type": "number", + "required": false + }, + { + "name": "input2", + "description": "Similar to `input1`, this string input is utilized only in the `hash` mode to further seed the ULID's random component, enabling the creation of a deterministic ULID based on the hash of the inputs.", + "default": "", + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/dbinfo.json b/data/en/dbinfo.json new file mode 100644 index 000000000..95eb39140 --- /dev/null +++ b/data/en/dbinfo.json @@ -0,0 +1,81 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/dbinfo.html"}}, + "name": "dbinfo", + "description": "Lets you retrieve information about a data source, including details about the database, tables, queries, procedures, foreign keys, indexes, and version information about the database, driver, and JDBC. This tag supports only JDBC drivers, and does not support ODBC-based drivers, including the Microsoft Access driver.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "datasource", + "description": "Datasource to use to connect to the database.", + "default": false, + "type": "object", + "required": false + }, + { + "name": "name", + "description": "Name to use to refer to the result.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "type", + "description": "Type of information to get:\n\n* dbnames: database name and type\n* tables: information to all tables\n* columns: column information to a single table/view\n* version: version information of the database\n* procedures: information to all procedures\n* procedure_columns: column information to a single procedure\n* foreignkeys: information to all foreignkeys\n* index: information to all indexes\n", + "default": false, + "type": "string", + "required": true + }, + { + "name": "procedure", + "description": "Name of the procedure from which you retrieve information.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "dbname", + "description": "Name of the database", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "Password to connect to the database.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "pattern", + "description": "Specifies a filter to retrieve information about specific tables, columns, or stored procedures", + "default": false, + "type": "string", + "required": false + }, + { + "name": "table", + "description": "Name of the table from which you retrieve information.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "username", + "description": "User name to connect to the database.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filter", + "description": "Filter for type=\"tables\" with a wildcard, defaults to all types when empty.\n\n- \"TABLE\"\n- \"VIEW\"\n- \"SYSTEM TABLE\"\n- \"GLOBAL TEMPORARY\"\n- \"LOCAL TEMPORARY\"\n- \"ALIAS\"\n- \"SYNONYM\"\n\nNote: Each Database implementation has it's own supported types\n\n**Introduced: Lucee 6.0.0.76**", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/debugadd.json b/data/en/debugadd.json new file mode 100644 index 000000000..a567dbd14 --- /dev/null +++ b/data/en/debugadd.json @@ -0,0 +1,22 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/debugadd.html"}}, + "name": "debugadd", + "description": "Adding data to debug output.", + "syntax": "debugadd( category, data )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "category", + "description": "category name for the data passed in.", + "type": "string", + "required": true + }, + { + "name": "data", + "description": "struct containing data to add to debug output.", + "type": "struct", + "required": true + } + ] +} \ No newline at end of file diff --git a/data/en/defaultcase.json b/data/en/defaultcase.json new file mode 100644 index 000000000..363ae912b --- /dev/null +++ b/data/en/defaultcase.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/defaultcase.html"}}, + "name": "defaultcase", + "description": "Defines a default action inside a cfswitch statement, when none of the cfcase condition statements are true.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/directory.json b/data/en/directory.json new file mode 100644 index 000000000..f349233f4 --- /dev/null +++ b/data/en/directory.json @@ -0,0 +1,132 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/directory.html", + "notes": "For ACF compatibility, on Unix Systems, the `mode` column is currently not populated for `action=\"list\"`\n\n" + }}, + "name": "directory", + "description": "Handles interactions with directories.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "Defines the action to be taken with directory(ies) specified in directory.\n\n- list [[function-directorylist]]\n- create [[function-directorycreate]]\n- delete [[function-directorydelete]]\n- rename [[function-directoryrename]]\n- copy [[function-directorycopy]]\n- forcedelete", + "default": false, + "type": "string", + "required": false + }, + { + "name": "listinfo", + "description": "- **all:** includes all information in the result set.\n- **name:** includes only filenames in the result set.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "storeacl", + "description": "An array of struct where each struct represents a permission or grant.\n\nExample:\n[{email=\"xxx@yyy.com\", permission=\"full_control\"}, {group=\"all\", permission=\"read\"}]", + "default": false, + "type": "object", + "required": false + }, + { + "name": "storelocation", + "description": "Only used for S3 Resources.\n\nThe location of the created bucket/object. The location can either be EU,US or US-WEST.\n\nThe default location is US.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "- **file:** includes only filenames.\n- **dir:** includes only directory names.\n- **all:** includes both filenames and directory names.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "serverpassword", + "description": "Allow you to access filesystem, also when access is denied for your context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "directory", + "description": "The name of the directory to perform the action against.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "name", + "description": "Required for action = \"list\". Ignored by all other actions. Name of output query for directory\nlisting.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filter", + "description": "Optional for action = \"list\". Ignored by all other actions.\n\nCan be either:\n\n- a wildcard filter,e.g. \"m*\"\n- or a UDF/Closure which accepts the file/directory name and returns a Boolean value to indicate\nwhether that item should be included in the result or not.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "filterdelimiters", + "description": "Optional when passing a filter pattern. This value is used as a delimiter for the patterns.\nDefault is the pipe \"|\" character.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "mode", + "description": "Used with action = \"Create\" to define the permissions for a directory on UNIX and Linux\nplatforms. Ignored on Windows.\n\nOptions correspond to the octal values of the UNIX chmod command. From\nleft to right, permissions are assigned for owner, group, and other.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "sort", + "description": "Optional for action = \"list\". Ignored by all other actions.\n\nThe query columns by which to sort the directory listing. Any combination of columns from query output can be specified in comma-separated list.\n\nYou can specify ASC (ascending) or DESC (descending) as qualifiers for column names. ASC is the default", + "default": false, + "type": "string", + "required": false + }, + { + "name": "newdirectory", + "description": "Required for action = \"rename\". Ignored by all other actions.\n\nThe new name of the directory specified in the directory attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "destination", + "description": "Required for action = \"copy\". Ignored by all other actions.\n\nPath of the destination directory. If not an absolute path, it is relative to the source directory.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "recurse", + "description": "Whether or not to include the content of any sub-directories", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "nameconflict", + "description": "When used with action=\"copy\" the possible values are:\n\n- Overwrite\n- Error\n\nWhen used with action=\"create\" the possible values are:\n\n- Error\n- Skip\n\nIgnored for all other actions.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "createpath", + "description": "- true (default), automatically create any parent directories which don't exist\n- false, all the parent directories must already exist or an error will be thrown\n", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/directoryinfo.json b/data/en/directoryinfo.json new file mode 100644 index 000000000..6a85d079a --- /dev/null +++ b/data/en/directoryinfo.json @@ -0,0 +1,18 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/directoryinfo.html", + "minimum_version": "6.0" + }}, + "name": "directoryinfo", + "description": "returns detailed info about the given directory.", + "syntax": "directoryinfo( source )", + "returns": "struct", + "type": "function", + "params": [{ + "name": "source", + "description": "directory path", + "aliases": "Directory", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/document.json b/data/en/document.json new file mode 100644 index 000000000..85f5532cf --- /dev/null +++ b/data/en/document.json @@ -0,0 +1,276 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/document.html"}}, + "name": "document", + "description": "Creates a PDF document from a text block containing CFML and HTML.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "backgroundvisible", + "description": "Specifies whether the background prints when the user prints the document", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "encryption", + "description": "define if the output should be encrypted and how deep", + "default": false, + "type": "String", + "required": false + }, + { + "name": "filename", + "description": "name for output file, if not defined output will be written to response stream", + "default": false, + "type": "String", + "required": false + }, + { + "name": "fontembed", + "description": "define if fonts will embedded with the file", + "default": false, + "type": "string", + "required": false + }, + { + "name": "fontdirectory", + "description": "directory that contains additional font files (.ttf) and a pd4fonts.properties to describe them.\n\n**Note**: Classic engine works using the font-family-name from pd4fonts.properties file. Modern (Flying saucer) engine works using the font-family-name from the .ttf file with the same case.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "format", + "description": "format of the created file", + "default": false, + "type": "string", + "required": false + }, + { + "name": "page", + "description": "Specifies the page info in a struct like this {width:10, height:5, type:A4}", + "default": false, + "type": "any", + "required": false + }, + { + "name": "margin", + "description": "Specifies the margin in inches (default), centimeters or points. The attribute unit controls the type.\npossible values is a number, so margin is the same all around, or a struct like this {top:1,bottom:1,left:2,right:2}", + "default": false, + "type": "any", + "required": false + }, + { + "name": "marginbottom", + "description": "Specifies the bottom margin in inches (default) or\ncentimeters. To specify bottom margin in\ncentimeters, include the unit=cm attribute.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "marginleft", + "description": "Specifies the left margin in inches (default) or\ncentimeters. To specify left margin in centimeters,\ninclude the unit=cm attribute.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "marginright", + "description": "Specifies the right margin in inches (default) or\ncentimeters. To specify right margin in centimeters,\ninclude the unit=cm attribute.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "margintop", + "description": "Specifies the top margin in inches (default) or\ncentimeters. To specify top margin in centimeters,\ninclude the unit=cm attribute.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "mimetype", + "description": "mimetype of the source (when attribute src or srcfile are defined)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "name of a variable to store the output in it", + "default": false, + "type": "string", + "required": false + }, + { + "name": "orientation", + "description": "Page orientation. Can be \"landscape\" or \"portrait\". Defaults to \"portrait\".\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "overwrite", + "description": "define if an existing file will be overwritten or not", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "ownerpassword", + "description": "Specifies an owner password (format=\"PDF\" only).", + "default": false, + "type": "string", + "required": false + }, + { + "name": "pageheight", + "description": "used when pagetype is custom", + "default": false, + "type": "number", + "required": false + }, + { + "name": "pagewidth", + "description": "used when pagetype is custom", + "default": false, + "type": "number", + "required": false + }, + { + "name": "pagetype", + "description": "defined the used format for the page (,legal,letter,A4,A5,B4,B5,B4-JIS,B5-JIS and custom)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "permissions", + "description": "Sets the permissions for the document\n\n- AllowPrinting\n- AllowModifyContents\n- AllowCopy\n- AllowModifyAnnotations\n- AllowFillIn\n- AllowScreenReaders\n- AllowAssembly\n- AllowDegradedPrinting\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "scale", + "description": "Define a scale factor as a percentage. This option is used to reduce the size of the HTML output so that it fits on that paper. Define a number less than 100.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "src", + "description": "define a url or a relative path on the local system to a file that should be transferred to a pdf", + "default": false, + "type": "string", + "required": false + }, + { + "name": "srcfile", + "description": "define an absolute path to a file that should be transferred to a pdf", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "Specifies which engine should be used to render the document.\n\nOptions are:\n\n- classic\n- modern (Available since PDF Extension version 1.0.0.92)\n \nDefaults to the Application's `this.pdf.type` setting (which defaults to \"modern\").\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "unit", + "description": "set the unit for pageheight, pagewidth, and margin...", + "default": false, + "type": "string", + "required": false + }, + { + "name": "userpassword", + "description": "Specifies a user password (format=\"PDF\" only). Defaults to \"empty\" if is not set, and encryption is set to 40 bit or 128 bit.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyhost", + "description": "alias for proxyHost", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyport", + "description": "The port number on the proxy server from which the object is requested. Default is 80. When\n\tused with resolveURL, the URLs of retrieved documents that specify a port number are automatically\n\tresolved to preserve links in the retrieved document.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "proxyuser", + "description": "When required by a proxy server, a valid username.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxypassword", + "description": "When required by a proxy server, a valid password.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "bookmark", + "description": "Specifies whether bookmarks are created in the document", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "htmlbookmark", + "description": "If true, it is possible to convert outlines to a list of named anchors (`label<\/a>`) or a headings structure (`

`...`

`). Transforming of HTML hyperlinks to PDF hyperlinks (if not explicitly disabled). Hyperlink jumps within the same document are supported as well", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "localurl", + "description": "Specifies whether to retrieve image files directly from the local drive", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "authuser", + "description": "User name sent to the target URL for Basic Authentication. Combined with password to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "authpassword", + "description": "Password sent to the target URL for Basic Authentication. Combined with username to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "useragent", + "description": "Text to put in the HTTP User-Agent request header field. Used to identify the request client software.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "saveasname", + "description": "(format=\"PDF\" only) The filename that appears in the SaveAs dialog when a user saves a PDF file written to the browser.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/documentitem.json b/data/en/documentitem.json new file mode 100644 index 000000000..c583b8436 --- /dev/null +++ b/data/en/documentitem.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/documentitem.html"}}, + "name": "documentitem", + "description": "Specifies action items for a PDF document created by the cfdocument tag.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "type", + "description": "Specifies the action:\n\n- pagebreak (starts a new page at the location of the tag)\n- header (uses the text between in the body of the tag as the running header)\n- footer (uses the text between the body of the tag as the running footer)\n- bookmark (set a bookmark, use the attribute name to define the name of the bookmark)", + "default": false, + "type": "string", + "required": true + }, + { + "name": "name", + "description": "used only for type bookmark, name of the bookmark to define.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "evalatprint", + "description": "Determines if the contents of the cfdocumentitem tag body has to be evaluated at the time of printing the document.\n\n- true: evaluates the contents of the cfdocumentitem tag body only at the time of printing the document.\n- false (default): evaluates the contents of the cfdocumentitem tag body immediately.\n", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/documentsection.json b/data/en/documentsection.json new file mode 100644 index 000000000..40397cfb7 --- /dev/null +++ b/data/en/documentsection.json @@ -0,0 +1,94 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/documentsection.html"}}, + "name": "documentsection", + "description": "Divides a PDF document into sections.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "marginbottom", + "description": "Specifies the bottom margin in inches (default) or centimeters.\n\nTo specify the bottom margin in centimeters, include the unit=\"cm\" attribute in the parent cfdocument tag.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "marginleft", + "description": "Specifies the left margin in inches (default) or\ncentimeters. To specify the left margin in centimeters,\ninclude the unit=\"cm\" attribute in the parent cfdocument\ntag.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "marginright", + "description": "Specifies the right margin in inches (default) or\ncentimeters. To specify the right margin in centimeters,\ninclude the unit=\"cm\" attribute in the parent cfdocument\ntag.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "margintop", + "description": "Specifies the top margin in inches (default) or\ncentimeters. To specify the top margin in centimeters,\ninclude the unit=\"cm\" attribute in the parent cfdocument\ntag.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "orientation", + "description": "Page orientation. Can be \"landscape\" or \"portrait\". Defaults to the orientation of the enclosing ``.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "src", + "description": "define a url or a relative path on the local system to a file that should be transferred to a pdf", + "default": false, + "type": "string", + "required": false + }, + { + "name": "srcfile", + "description": "define an absolute path to a file that should be transferred to a pdf", + "default": false, + "type": "string", + "required": false + }, + { + "name": "mimetype", + "description": "mimetype of the source (when attribute src or srcfile are defined)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "Bookmark name for the section", + "default": false, + "type": "string", + "required": false + }, + { + "name": "authuser", + "description": "User name sent to the target URL for Basic Authentication. Combined with password to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "authpassword", + "description": "Password sent to the target URL for Basic Authentication. Combined with username to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "useragent", + "description": "Text to put in the HTTP User-Agent request header field. Used to identify the request client software.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/dump.json b/data/en/dump.json new file mode 100644 index 000000000..d08a64ae7 --- /dev/null +++ b/data/en/dump.json @@ -0,0 +1,122 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/Dump.html"}}, + "name": "Dump", + "description": "Outputs the elements, variables and values of most kinds of CFML objects. Useful for debugging. You can display the contents of simple and complex variables, objects, components, user-defined functions, and other elements.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "var", + "description": "Variable to display. Enclose a variable name in pound signs.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "eval", + "description": "name of the variable to display, also used as label, when no label defined.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "expand", + "description": "expands views", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "label", + "description": "header for the dump output.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "top", + "description": "The number of rows to display.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "showUDFs", + "description": "show UDFs in cfdump output.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "show", + "description": "show column or keys.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "output", + "description": "Where to send the results:\n\n- **browser:** the result is written to the browser response stream (default).\n- **console:** the result is written to the console (System.out).\n- **debug:** the result is written to the debugging logs, when debug is enabled.\n- **false:** output will not be written, effectively disabling the dump.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "metainfo", + "description": "Includes information about the query in the cfdump results.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "keys", + "description": "For a structure, number of keys to display.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "hide", + "description": "hide column or keys.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "format", + "description": "specify the output format of the dump, the following formats are available by default:\n\n- **html:** the default browser output\n- **text:** this is the default when outputting to console and plain text in the browser\n- **classic:** classic view with HTML/CSS/JavaScript\n- **simple:** no formatting in the output\n\nYou can use your custom style by creating a corresponding file in the lucee/dump/skins folder. Check the folder for examples.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "abort", + "description": "stops further processing of request.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "async", + "description": "if true and output is not to browser, Lucee builds the output in a new thread that runs in parallel to the thread that called the dump. please note that if the calling thread modifies the data before the dump takes place, it is possible that the dump will show the modified data.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "enabled", + "description": "dumps are enabled by default, pass false to short circuit a dump execution and effectively disable it", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "flush", + "description": "flushes the response stream after the dump", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/else.json b/data/en/else.json new file mode 100644 index 000000000..3c9a4586a --- /dev/null +++ b/data/en/else.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/else.html"}}, + "name": "else", + "description": "Used with cfelse and cfelseif, cfif lets you create simple and compound conditional statements\nin CFML. The value in the cfif tag can be any expression.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/elseif.json b/data/en/elseif.json new file mode 100644 index 000000000..e9adad56d --- /dev/null +++ b/data/en/elseif.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/elseif.html"}}, + "name": "elseif", + "description": "Used with cfelse and cfelseif,\ncfif lets you create simple and compound conditional statements\nin CFML. The value in the cfif tag can be any expression.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "condition", + "description": "Expression condition", + "default": false, + "type": "boolean", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/encodeforsql.json b/data/en/encodeforsql.json new file mode 100644 index 000000000..0d67aab27 --- /dev/null +++ b/data/en/encodeforsql.json @@ -0,0 +1,30 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/encodeforsql.html"}}, + "name": "encodeforsql", + "description": "Encodes the given string for safe output in a query to reduce the risk of SQL Injection attacks. _This method is not recommended_ - the use of query parameters are strongly encouraged as a stronger alternative.", + "syntax": "encodeforsql( string, dialect )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "string", + "description": "string to encode", + "type": "string", + "required": true + }, + { + "name": "dialect", + "description": "SQL dialect used to encode, possible values are:\n\t\t\t\t* db2\n\t\t\t\t* mysql_ansi\n\t\t\t\t* mysql\n\t\t\t\t* oracle", + "type": "string", + "required": true + }, + { + "name": "canonicalize", + "description": "If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding.", + "minimum_version": "boo", + "default": "false", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/error.json b/data/en/error.json new file mode 100644 index 000000000..eadeeae76 --- /dev/null +++ b/data/en/error.json @@ -0,0 +1,38 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/error.html"}}, + "name": "error", + "description": "Enables the display of customized HTML pages when errors occur. This lets you maintain a\nconsistent look and feel within your application, even when errors occur.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "type", + "description": "The type of error that the custom error page handles.\n\n- exception\n- request\n", + "default": false, + "type": "string", + "required": true + }, + { + "name": "template", + "description": "The relative path to the custom error page.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "mailto", + "description": "The e-mail address of the administrator to notify of the error. The value\n\tis available to your custom error page in the MailTo property of the error object.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "exception", + "description": "Type of exception. Required if type = \"exception\" or \"monitor\".", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/execute.json b/data/en/execute.json new file mode 100644 index 000000000..9e30d4f6d --- /dev/null +++ b/data/en/execute.json @@ -0,0 +1,114 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/execute.html"}}, + "name": "execute", + "description": "Enables developers to execute a process on a server computer.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "The full pathname of the application to execute.\n\nNote: On Windows, you must specify the extension as part of the application's name. For example,\nmyapp.exe,", + "default": false, + "type": "string", + "required": false + }, + { + "name": "arguments", + "description": "Command-line arguments passed to the application.\n\n- arguments as a string\n- arguments as an Array (recommended)\n", + "default": false, + "type": "any", + "required": false + }, + { + "name": "outputfile", + "description": "The file to which to direct the output of the program. If not specified, the output is\ndisplayed on the page from which it was called.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "Indicates how long, in seconds, the executing thread waits for the spawned process.\n\nA timeout of 0 is equivalent to the non-blocking mode of executing. A very high timeout value is\nequivalent to a blocking mode of execution. The default is 0; therefore, the thread spawns\na process and returns without waiting for the process to terminate.If no output file is specified,\nand the timeout value is 0, the program output is discarded.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "terminateontimeout", + "description": "terminate execution of process when timeout occur. Defaults to false.\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "variable", + "description": "Variable in which to put program output.\n\nIf no output file or variable attribute is specified,\noutput is displayed on page from which it was called.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "errorfile", + "description": "The file to which to direct the error stream of the program. If neither errorFile nor errorVariable is specified, the error stream is discarded.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "errorvariable", + "description": "Variable in which to put program error stream output. If neither errorFile nor errorVariable is specified, the error stream is discarded.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "directory", + "description": "The working directory in which to execute the command", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "environment", + "description": "An array of key value pairs", + "minimum_version": "str", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "result", + "description": "The name of a variable to place the return struct, containing [ output, error, exitCode ]", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "exitcodevariable", + "description": "Variable in which to put the exit code value.", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "onprogress", + "description": "A UDF which receives two arguments, the progressive output and the java Process instance for the execution.\nIf defined, output to the other variables will be null.\nThe java Process instance can be used to interact with the executing process, i.e. via getOutputSteam().\nhttps://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Process.html \nReturning false from the Listener will cancel the process execution", + "minimum_version": "any", + "default": false, + "type": "any", + "required": false + }, + { + "name": "onerror", + "description": "A UDF Listener which receives a single argument, output. \nOptional, If a OnProgress Listener is defined, but no onError listener, the error stream is redirected to the onProgress Listener.\nReturning false from the Listener will cancel the process execution", + "minimum_version": "any", + "default": false, + "type": "any", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/exit.json b/data/en/exit.json new file mode 100644 index 000000000..46dae4cc2 --- /dev/null +++ b/data/en/exit.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/exit.html"}}, + "name": "exit", + "description": "Used to: Abort the processing of the currently executing CFML custom tag, exit the template\nwithin the currently executing CFML custom tag and re-execute a section of code within the currently\nexecuting CFML custom tag", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "method", + "description": "Allowed values:\n\n* **exittag**: aborts processing of currently executing tag\n* **exittemplate**: exits page of currently executing tag\n* **loop**: reexecutes body of currently executing tag\n", + "default": false, + "type": "string", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/extensioninfo.json b/data/en/extensioninfo.json new file mode 100644 index 000000000..7d720cddf --- /dev/null +++ b/data/en/extensioninfo.json @@ -0,0 +1,17 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/extensioninfo.html", + "minimum_version": "6.0" + }}, + "name": "extensioninfo", + "description": "Returns the detailed info about the extension.", + "syntax": "extensioninfo( id )", + "returns": "struct", + "type": "function", + "params": [{ + "name": "id", + "description": "Id of the extension", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/feed.json b/data/en/feed.json new file mode 100644 index 000000000..d986c7d84 --- /dev/null +++ b/data/en/feed.json @@ -0,0 +1,137 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/feed.html"}}, + "name": "feed", + "description": "Reads or creates an RSS or Atom syndication feed.\nThis tag can read various RSS and Atom 0.3 versions. It can create RSS 2.0 or Atom 1.0 feeds.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "The name to use for the JavaScript proxy class.\nThe action to take, one of the following values:\n\n- create: Creates an RSS 2.0 or Atom 1.0 feed XML document and saves it in a variable, writes it to a file, or both.\n- read (default): Parses an RSS or Atom feed from a URL or an XML file and saves it in a structure or query.\n\nYou can also get query metadata in a separate structure.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "columnmap", + "description": "Used only for the create action with a query attribute.\nA structure specifying a mapping between the names of the columns in the object specified by the query attribute\nand the columns of the feed format, as described in the Query attribute section.\nThe key for each field must be a column name listed in the Query columns section. The value of the field must be\nthe name of the corresponding column in the query object used as input to the create action.", + "minimum_version": "str", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "enclosuredir", + "description": "Used only for the read action.\nPath to the directory in which to save any enclosures that are available in the feed being read.\nThe path can be absolute or relative to the CFML file.\nIf the directory does not exist, Lucee generates an error.\nIf you omit this attribute, Lucee does not save enclosures.\nTo specify the directory that contains the current page, set this attribute to .(period).", + "default": false, + "type": "string", + "required": false + }, + { + "name": "ignoreenclosureerror", + "description": "If this attribute is true, Lucee attempts to save all enclosures.\n\nIf it encounters an error downloading one enclosure, it continues downloading other enclosures and writes the\nerror information in the server log.\n\nIf this attribute is false, Lucee stops downloading all enclosures and generates an error when it encounters\nan error downloading an enclosure.\n\nNote: Enclosure errors can occur if the specified enclosure is of a type that the web server does not allow to be\ndownloaded. (optional, default=false)", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "name", + "description": "A structure that contains complete feed data:\nThe output of a read action.\nThe input definition of the feed to create.\nThis structure contains complete feed information.\nWhen you specify the name attribute for a create action, you must put it in pound signs (#).", + "default": false, + "type": "any", + "required": false + }, + { + "name": "outputfile", + "description": "Path of the file in which to write the feed as XML text.\nThe path can be absolute, or relative to the CFML file.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "overwrite", + "description": "Whether to overwrite the XML feed file if it already exists.\nIf you do not set this attribute to true and the cffeed tag tries to write to a file that exists, Lucee\ngenerates an error. (optional, default=false)", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "overwriteenclosure", + "description": "Used only for the read action.\nWhether to overwrite files in the enclosure directory if they already exist.\nIf you do not set this attribute to true and the cffeed tag tries to write to a file that exists, Lucee\ngenerates an error. (optional, default=false)", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "properties", + "description": "A structure containing the feed metadata, the information about the entire feed.\nCan contain either of the following:\n\n- The output of a read action.\n- Input to a create action.\n\nThe properties and query attributes combined provide complete feed information.\nWhen you specify the properties attribute for a create action, you must put it in pound signs (#)", + "default": false, + "type": "any", + "required": false + }, + { + "name": "proxypassword", + "description": "Password required by the proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyport", + "description": "The port to connect to on the proxy server.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "proxyserver", + "description": "Host name or IP address of a proxy server to which to send the request.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyuser", + "description": "User name to provide to the proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "query", + "description": "A query object containing the Atom entries or RSS items in the feed. Can contain either of the following:\nThe output of a read action.\nInput to a create action.\nThe properties and query attributes combined provide complete feed information.\nWhen you specify the query attribute for a create action, you must put it in pound signs (#)", + "default": false, + "type": "any", + "required": false + }, + { + "name": "source", + "description": "Used only for the read action.\nThe URL of the feed or the path to the XML file that contains the feed contents.\nA path can be absolute, or relative to the CFML file.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "The number of seconds to wait for a response from the feed source. A value of 0 specifies that the request does not time out.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "useragent", + "description": "Text to put in the HTTP User-Agent request header field. Used to identify the request client software.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "xmlvar", + "description": "A variable in which to save the read or created feed as XML text.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/file.json b/data/en/file.json new file mode 100644 index 000000000..71eec56f8 --- /dev/null +++ b/data/en/file.json @@ -0,0 +1,167 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/file.html"}}, + "name": "file", + "description": "Handles all interactions with files", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "storeacl", + "description": "Access Control List (ACL) to use for new files. Can be a either a string (`\"authenticated-read\"`, `\"private\"`, `\"public-read\"`, or `\"public-read-write\"`), or\nan array of structs where each struct represents a permission or grant.\n\nExample:\n```[{email=\"xxx@yyy.com\", permission=\"full_control\"}, {group=\"all\", permission=\"read\"}]```\n\nDefaults to the value specified in the application's `this.s3.acl`, which is `\"public\"` if unspecified.\n", + "default": false, + "type": "object", + "required": false + }, + { + "name": "action", + "description": "Type of file manipulation that the tag performs.\n\n- info [[function-fileinfo]]\n- move [[function-filemove]]\n- rename\n- copy [[function-filecopy]]\n- delete [[function-filedelete]]\n- read [[function-fileread]]\n- readbinary [[function-filereadbinary]]\n- write [[function-filewrite]]\n- append [[function-fileappend]]\n- upload [[function-fileupload]]\n- uploadall [[function-fileuploadall]]\n- touch [[function-filetouch]]\n \n**Note:** action upload return the [[file-upload-result| status of the upload operation ]] as a struct after the file upload", + "default": false, + "type": "string", + "required": true + }, + { + "name": "serverpassword", + "description": "allow you to access filesystem, also when access is denied for your context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "source", + "description": "Absolute pathname of file on web server.\nOn Windows, use backward slashes; on UNIX, use forward slashes.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "attributes", + "description": "One attribute (Windows) or a comma-delimited list of attributes (other platforms) to set on the file.\n\nIf omitted, the file's attributes are maintained.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "destination", + "description": "Absolute pathname of directory or file on web server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "mode", + "description": "Applies only to Solaris and HP-UX. Permissions. Octal values of UNIX chmod command. Assigned to owner, group, and other, respectively.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filefield", + "description": "Name of form field used to select the file.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "charset", + "description": "Character set name for the file contents.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "nameconflict", + "description": "Action to take if filename is the same as that of a file in the directory.\n\n- skip\n- error\n- overwrite\n- makeunique\n- forceunique", + "default": false, + "type": "string", + "required": false + }, + { + "name": "accept", + "description": "list of supported extensions or/and mimetypes.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "strict", + "description": "for action \"upload\" and \"uploadAll\":\n\nif set to true (default), only mimetypes are supported.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "createpath", + "description": "for action \"append\", \"touch\" and \"write\":\n\nif set to false (default), expects all parent directories to exist, true will generate necessary directories", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "file", + "description": "Absolute pathname of file on web server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "variable", + "description": "Name of variable to contain contents of text file.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "output", + "description": "Content of the file to be created.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "cachedwithin", + "description": "possible values are:\n\n- String \"request\": If original content was created within the current request, cached content data is used.\n- a timespan (created with function CreateTimeSpan): If original content date falls within the time span, cached content data is used.\n\nTo use cached data, the tag must be called with the exact same arguments.\n\nOnly used by action \"read\" and \"readbinary\"", + "minimum_version": "obj", + "default": false, + "type": "object", + "required": false + }, + { + "name": "addnewline", + "description": "Yes: appends newline character to text written to file", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "fixnewline", + "description": "- **true:** changes embedded line-ending characters in string variables to operating-system specific line endings\n- **false:** (default) do not change embedded line-ending characters in string variables.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "result", + "description": "Name of the result value (default:cffile)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "allowedextensions", + "description": "String list or string array of extensions allowed, this overwrites any other setting including the attribute [blockedExtensions] and settings done for example in the Application.cfc.", + "minimum_version": "any", + "default": false, + "type": "any", + "required": false + }, + { + "name": "blockedextensions", + "description": "String list or string array of extensions blocked, this overwrites any setting done for example in the Application.cfc.", + "minimum_version": "any", + "default": false, + "type": "any", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/fileinfo.json b/data/en/fileinfo.json new file mode 100644 index 000000000..ea095b849 --- /dev/null +++ b/data/en/fileinfo.json @@ -0,0 +1,18 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/fileinfo.html", + "minimum_version": "5.0" + }}, + "name": "fileinfo", + "description": "returns detailed info about the given file.", + "syntax": "fileinfo( file )", + "returns": "struct", + "type": "function", + "params": [{ + "name": "file", + "description": "file path", + "aliases": "resource", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/filemodetosymbolic.json b/data/en/filemodetosymbolic.json new file mode 100644 index 000000000..b2f35f367 --- /dev/null +++ b/data/en/filemodetosymbolic.json @@ -0,0 +1,17 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/filemodetosymbolic.html", + "minimum_version": "7.0" + }}, + "name": "filemodetosymbolic", + "description": "Converts a mode mask to it's symbolic representation.", + "syntax": "filemodetosymbolic( mode )", + "returns": "string", + "type": "function", + "params": [{ + "name": "mode", + "description": "A three-digit value, in which each digit specifies the file access for individuals and groups:\n\n- The first digit represents the owner.\n- The second digit represents a group.\n- The third digit represents anyone.\n\nEach digit of this code sets permissions for the appropriate individual or group:\n\n- 4 specifies read permission.\n- 2 specifies write permission.\n- 1 specifies execute permission.\n\nYou use the sums of these numbers to indicate combinations of the permissions:\n\n- 3 specifies write and execute permission.\n- 5 specifies read and execute permission.\n- 6 indicates read and write permission.\n- 7 indicates read, write, and execute permission.\n\nFor example, 400 specifies that only the owner can read the file; 004 specifies that anyone can read the file.", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/filetouch.json b/data/en/filetouch.json new file mode 100644 index 000000000..29dbd15e8 --- /dev/null +++ b/data/en/filetouch.json @@ -0,0 +1,22 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/filetouch.html"}}, + "name": "filetouch", + "description": "Touches given file, creates the file if not already exists.", + "syntax": "filetouch( file )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "file", + "description": "file to touch.", + "type": "any", + "required": true + }, + { + "name": "createPath", + "description": "if set to false, expects all parent directories to exist, true (default) will generate necessary directories", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/finally.json b/data/en/finally.json new file mode 100644 index 000000000..8167d86e7 --- /dev/null +++ b/data/en/finally.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/finally.html"}}, + "name": "finally", + "description": "Used inside a cftry tag.\nCode in the cffinally block is processed after the main cftry code and, if an exception occurs, the cfcatch code.\nThe cffinally block code always executes, whether or not there is an exception.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/findlast.json b/data/en/findlast.json new file mode 100644 index 000000000..42ced04d8 --- /dev/null +++ b/data/en/findlast.json @@ -0,0 +1,32 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/findlast.html", + "minimum_version": "5.3" + }}, + "name": "findlast", + "description": "Finds the last occurrence of a substring in a string, from a\nspecified start position. The search is case-sensitive.", + "syntax": "findlast( substring, string )", + "returns": "number", + "type": "function", + "params": [ + { + "name": "substring", + "description": "String for which to search.", + "type": "string", + "required": true + }, + { + "name": "string", + "description": "String in which to search.", + "type": "string", + "required": true + }, + { + "name": "start", + "description": "End position of search from the left.", + "default": "1", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/findlastnocase.json b/data/en/findlastnocase.json new file mode 100644 index 000000000..1c9084507 --- /dev/null +++ b/data/en/findlastnocase.json @@ -0,0 +1,32 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/findlastnocase.html", + "minimum_version": "5.3" + }}, + "name": "findlastnocase", + "description": "Finds the last occurrence of a substring in a string, from a\nspecified start position. If substring is not in string,\nreturns zero. The search is case-insensitive.", + "syntax": "findlastnocase( substring, string )", + "returns": "number", + "type": "function", + "params": [ + { + "name": "substring", + "description": "String for which to search.", + "type": "string", + "required": true + }, + { + "name": "string", + "description": "String in which to search.", + "type": "string", + "required": true + }, + { + "name": "start", + "description": "End position of search from the left.", + "default": "1", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/flush.json b/data/en/flush.json new file mode 100644 index 000000000..8a2484c93 --- /dev/null +++ b/data/en/flush.json @@ -0,0 +1,24 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/flush.html"}}, + "name": "flush", + "description": "Flushes currently available data to the client.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "interval", + "description": "Flush the output each time at least the specified number of bytes become available. HTML\nheaders, and any data that is already available when you make this call, are not included in\nthe count.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "throwonerror", + "description": "If set to false, any exceptions thrown by the servlet engine, such as those resulting from a client disconnection, will be suppressed.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/forward.json b/data/en/forward.json new file mode 100644 index 000000000..b150a7836 --- /dev/null +++ b/data/en/forward.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/forward.html"}}, + "name": "forward", + "description": "Leads the request to a different page.\nThis tag acts like the tag cflocation except that the relocation is done directly on the server.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "template", + "description": "template path to forward to", + "default": false, + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/ftp.json b/data/en/ftp.json new file mode 100644 index 000000000..1fa15971a --- /dev/null +++ b/data/en/ftp.json @@ -0,0 +1,227 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/ftp.html"}}, + "name": "ftp", + "description": "Lets users implement File Transfer Protocol (FTP) operations.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "the FTP action to be executed\n\n- open\n- close\n- listDir\n- createDir\n- removeDir\n- changeDir\n- getCurrentDir\n- getCurrentURL\n- existsFile\n- existsDir\n- exists\n- getFile\n- putFile\n- rename\n- remove\n", + "default": false, + "type": "string", + "required": true + }, + { + "name": "username", + "description": "The Username for the connection", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "The Password for the connection", + "default": false, + "type": "string", + "required": false + }, + { + "name": "server", + "description": "The Server to connect", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for the connection", + "default": false, + "type": "number", + "required": false + }, + { + "name": "port", + "description": "server port of the connection", + "default": false, + "type": "number", + "required": false + }, + { + "name": "connection", + "description": "the name for the connection, used to cache the connection", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyserver", + "description": "Host name or IP address of a proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyport", + "description": "The port number on the proxy server from which the object is requested. Default is 80. When\n\tused with resolveURL, the URLs of retrieved documents that specify a port number are automatically\n\tresolved to preserve links in the retrieved document.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "proxyuser", + "description": "When required by a proxy server, a valid username.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxypassword", + "description": "When required by a proxy server, a valid password.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "retrycount", + "description": "retry count", + "default": false, + "type": "number", + "required": false + }, + { + "name": "stoponerror", + "description": "define if execution halt on error or not", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "passive", + "description": "enable passive mode", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "name", + "description": "name of the query for list directory", + "default": false, + "type": "string", + "required": false + }, + { + "name": "directory", + "description": "remote directory to list", + "default": false, + "type": "string", + "required": false + }, + { + "name": "asciiextensionlist", + "description": "Delimited list of file extensions that force ASCII transfer mode, if transferMode = \"auto\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "transfermode", + "description": "- ASCII\n- binary \n- auto (default)\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "remotefile", + "description": "File on the Server", + "default": false, + "type": "string", + "required": false + }, + { + "name": "localfile", + "description": "File on the current machine", + "default": false, + "type": "string", + "required": false + }, + { + "name": "failifexists", + "description": "throw an error if local file already exist or overwrite it", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "existing", + "description": "source or existing file or directory to rename", + "default": false, + "type": "string", + "required": false + }, + { + "name": "new", + "description": "new name for file or directory", + "default": false, + "type": "string", + "required": false + }, + { + "name": "item", + "description": "item on the server", + "default": false, + "type": "string", + "required": false + }, + { + "name": "result", + "description": "Name of the result value (default:cfftp)", + "default": false, + "type": "string", + "required": false + }, + { + "name": "fingerprint", + "description": "the ssh fingerprint", + "default": false, + "type": "string", + "required": false + }, + { + "name": "secure", + "description": "Secure connection (sftp|shh) or not.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "recurse", + "description": "delete content of the directory", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "key", + "description": "the ssh private key", + "default": false, + "type": "string", + "required": false + }, + { + "name": "passphrase", + "description": "the passphrase that protects ssh private key", + "default": false, + "type": "string", + "required": false + }, + { + "name": "actionparam", + "description": "used with action=\"quote\" to execute custom ftp commands", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/function.json b/data/en/function.json new file mode 100644 index 000000000..43b815365 --- /dev/null +++ b/data/en/function.json @@ -0,0 +1,150 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/function.html"}}, + "name": "function", + "description": "Defines a function within a CFML component that can accept arguments and return a value.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "A string; a component method that is used within the cfcomponent tag.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "returntype", + "description": "String; a type name; data type of the function return value", + "default": false, + "type": "string", + "required": false + }, + { + "name": "bufferoutput", + "description": "This attribute is only used when output of the function is set to false. If this attribute is set to true (default) the output written to the body of the function is buffered and in case of an exception also outputted.\n\nIf set to false the content to body is ignored and not disabled when a failure in the body of the tag occur.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "roles", + "description": "This attribute is used only for a component. If this attribute is omitted, all roles can invoke the method.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "access", + "description": "This attribute is used only within a component.\nThe client security context from which the method can be invoked\n\n- remote\n- public\n- package\n- private\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "output", + "description": "This attribute is used only for a component.\n\n- yes: the function is processed as if it were within a [[tag-output]] tag\n- no: the function is processed as if it were within a [[tag-silent]] tag", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "displayname", + "description": "Display Name of the Function", + "default": false, + "type": "string", + "required": false + }, + { + "name": "hint", + "description": "Hint of the Function", + "default": false, + "type": "string", + "required": false + }, + { + "name": "abstract", + "description": "is the function abstract or not, abstract functions are only allowed inside interface or component tags", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "description", + "description": "Supplies a short text description of the function.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "returnformat", + "description": "The format in which to return values to a remote caller.\n\nSupported values are \n\n- [wddx] \n- json \n- plain (text) \n- serialize (cfml, cfm) \n- xml\n- java", + "default": false, + "type": "string", + "required": false + }, + { + "name": "securejson", + "description": "A Boolean value that specifies whether to add a security prefix in front of any value that the function returns in JSON-format in response to a remote call.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "verifyclient", + "description": "A Boolean value that specifies whether to require remote function calls to include an encrypted security token. For use with AJAX applications only.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "localmode", + "description": "Defines how the local scope of this function is invoked when a variable with no scope definition is used. Accepted values include:\n\n- classic (default): The local scope is only invoked when the key already exists in it (also aliased as `false`).\n- modern: The local scope is always invoked (also aliased as `true`).\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cachedwithin", + "description": "possible values are:\n\n- String \"request\": If original content was created within the current request, cached content data is used.\n- a timespan (created with [[function-createtimespan]]): If original content date falls within the time span, cached content data is used.\n\nTo use cached data, the function must be called with the exact same arguments (part of the cache key is a hash of the arguments)\n", + "default": false, + "type": "object", + "required": false + }, + { + "name": "modifier", + "description": "Use modifier to denote a function as abstract, static or final.\n\n- abstract: implementation must be defined in extended component.\n- final: implementation cannot be extended.\n- static: does not access instance variables in the component.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "consumes", + "description": "A comma-separated list of acceptable MIME types that the function can accept or consume. If no value is specified, all MIME types are consumed by default. Use this attribute to control the types of content the function can handle. This attribute overrides the `consumes` attribute at the component level.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "produces", + "description": "A comma-separated list of MIME types that the function can produce. The function will respond with the most acceptable media type as declared by the client. This attribute overrides the `produces` attribute at the component level.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "httpmethod", + "description": "Specifies the HTTP method to use when calling the function as part of a RESTful service. Accepted values include:\n\n- `GET`: Requests information from the server.\n- `POST`: Sends information to the server for processing.\n- `PUT`: Requests the server to store the message body at the specified URL.\n- `DELETE`: Requests the server to delete the specified URL.\n- `HEAD`: Similar to GET but without a response body.\n- `OPTIONS`: Requests information about the communication options available for the server or the specified URL.\n\nIf not specified, the `GET` method is used by default.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "restpath", + "description": "Defines a sub-resource path for the function when used as part of a RESTful web service. The path is case-sensitive and should avoid special characters. Regular expressions can be included in the path.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/gatewayaction.json b/data/en/gatewayaction.json new file mode 100644 index 000000000..ddc076119 --- /dev/null +++ b/data/en/gatewayaction.json @@ -0,0 +1,38 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/gatewayaction.html", + "minimum_version": "6.2" + }}, + "name": "gatewayaction", + "description": "Executes a specifc action for a gateway instance.", + "syntax": "gatewayaction( gatewayID, action )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "gatewayID", + "description": "Identifier of the gateway to do the action on.", + "type": "string", + "required": true + }, + { + "name": "action", + "description": "action to execute, possible values are [start,stop and restart]", + "type": "string", + "required": true + }, + { + "name": "waitForIt", + "description": "Wait for the process to end (starting, stopping or restarting)", + "default": "true", + "type": "boolean", + "required": false + }, + { + "name": "timeout", + "description": "in case `waitForIt` is set to `true`, this defines how long we wait for the process to end, default is one second.", + "type": "timespan", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/gatewaystate.json b/data/en/gatewaystate.json new file mode 100644 index 000000000..9def0cad8 --- /dev/null +++ b/data/en/gatewaystate.json @@ -0,0 +1,17 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/gatewaystate.html", + "minimum_version": "6.2" + }}, + "name": "gatewaystate", + "description": "Return the current state for the given gateway id.", + "syntax": "gatewaystate( gatewayID )", + "returns": "string", + "type": "function", + "params": [{ + "name": "gatewayID", + "description": "Identifier of the gateway to get info for.", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/generate3deskey.json b/data/en/generate3deskey.json new file mode 100644 index 000000000..8867cf9d5 --- /dev/null +++ b/data/en/generate3deskey.json @@ -0,0 +1,14 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/generate3deskey.html"}}, + "name": "generate3deskey", + "description": "Generates a secure key value for use in the encrypt function with the 3DES algorithm.", + "syntax": "generate3deskey( )", + "returns": "string", + "type": "function", + "params": [{ + "name": "input", + "description": "A string input off of which the key will be based", + "type": "string", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/generatersakeys.json b/data/en/generatersakeys.json new file mode 100644 index 000000000..a9de81eb7 --- /dev/null +++ b/data/en/generatersakeys.json @@ -0,0 +1,16 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/generatersakeys.html"}}, + "name": "generatersakeys", + "description": "Generates a secure keys (private and public) for use in the encrypt function with the RSA algorithm.", + "syntax": "generatersakeys( )", + "returns": "struct", + "type": "function", + "params": [{ + "name": "key_size", + "description": "Number of bits to use for the generated Keys.", + "minimum_version": "num", + "default": "1024", + "type": "number", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/getcomponentstaticscope.json b/data/en/getcomponentstaticscope.json new file mode 100644 index 000000000..048aeaa02 --- /dev/null +++ b/data/en/getcomponentstaticscope.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/getcomponentstaticscope.html"}}, + "name": "getcomponentstaticscope", + "description": "returns the static scope of a specific component, of course access rules apply.", + "syntax": "getcomponentstaticscope( component )", + "returns": "struct", + "type": "function", + "params": [{ + "name": "component", + "description": "name of the component to get static scope, for example \"org.lucee.cfml.Query\".", + "aliases": "name,componentName,cfc", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/getcontextinfo.json b/data/en/getcontextinfo.json new file mode 100644 index 000000000..662ee2667 --- /dev/null +++ b/data/en/getcontextinfo.json @@ -0,0 +1,12 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/getcontextinfo.html", + "minimum_version": "5.3" + }}, + "name": "getcontextinfo", + "description": "Returns information about the current context.", + "syntax": "getcontextinfo( )", + "returns": "struct", + "type": "function", + "params": [] +} \ No newline at end of file diff --git a/data/en/gethttprequestheaders.json b/data/en/gethttprequestheaders.json new file mode 100644 index 000000000..065605f84 --- /dev/null +++ b/data/en/gethttprequestheaders.json @@ -0,0 +1,12 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/gethttprequestheaders.html", + "minimum_version": "5.3" + }}, + "name": "gethttprequestheaders", + "description": "Returns a Struct with HTTP Request Headers", + "syntax": "gethttprequestheaders( )", + "returns": "struct", + "type": "function", + "params": [] +} \ No newline at end of file diff --git a/data/en/getpropertyfile.json b/data/en/getpropertyfile.json new file mode 100644 index 000000000..449624840 --- /dev/null +++ b/data/en/getpropertyfile.json @@ -0,0 +1,26 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/getpropertyfile.html", + "minimum_version": "7.0" + }}, + "name": "getpropertyfile", + "description": "Read the properties from a properties file.", + "syntax": "getpropertyfile( filePath )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "filePath", + "description": "Path of the properties initialization file", + "type": "string", + "required": true + }, + { + "name": "encoding", + "description": "Encoding for the properties file", + "default": "UTF-8", + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/getpropertystring.json b/data/en/getpropertystring.json new file mode 100644 index 000000000..b9560f294 --- /dev/null +++ b/data/en/getpropertystring.json @@ -0,0 +1,32 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/getpropertystring.html", + "minimum_version": "7.0" + }}, + "name": "getpropertystring", + "description": "Sets the value of a property entry in a properties file.", + "syntax": "getpropertystring( filePath, key )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "filePath", + "description": "Path of the properties file", + "type": "string", + "required": true + }, + { + "name": "key", + "description": "Name of the key to return", + "type": "string", + "required": true + }, + { + "name": "encoding", + "description": "Encoding for the properties file", + "default": "UTF-8", + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/getsecret.json b/data/en/getsecret.json new file mode 100644 index 000000000..caf890651 --- /dev/null +++ b/data/en/getsecret.json @@ -0,0 +1,22 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/getsecret.html"}}, + "name": "getsecret", + "description": "Returns a reference to a secret value stored in a configured Secret Provider. The function doesn't immediately return the actual value, but rather a value object that can be handled by Lucee like a simple value.\nThis reference is automatically resolved to its actual value when:\n- It's converted to a real simple value (string, boolean, number, date)\n- It's used in operations requiring a simple value\nWhen used, the function automatically validates that the secret exists and throws an exception if not found.", + "syntax": "getsecret( key )", + "returns": "any", + "type": "function", + "params": [ + { + "name": "key", + "description": "Key to read from the Secret Provider (e.g., \"database.password\", \"api.key\")", + "type": "string", + "required": true + }, + { + "name": "name", + "description": "Name of the Secret Provider to read from, as configured in .CFConfig.json. If not defined, the function checks all configured providers in the order they are defined in .CFConfig.json until it finds the secret.", + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/getsystemproporenvvar.json b/data/en/getsystemproporenvvar.json new file mode 100644 index 000000000..005b5ca46 --- /dev/null +++ b/data/en/getsystemproporenvvar.json @@ -0,0 +1,17 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/getsystemproporenvvar.html", + "minimum_version": "6.2" + }}, + "name": "getsystemproporenvvar", + "description": "Return the list of supported system properties or env vars Lucee supports.", + "syntax": "getsystemproporenvvar( )", + "returns": "any", + "type": "function", + "params": [{ + "name": "property", + "description": "Optional, when set, the value of the property as configured is returned", + "type": "string", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/header.json b/data/en/header.json new file mode 100644 index 000000000..6621baf6f --- /dev/null +++ b/data/en/header.json @@ -0,0 +1,45 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/header.html"}}, + "name": "header", + "description": "Generates custom HTTP response headers to return to the client.", + "syntax": "
", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "A name for the header.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "value", + "description": "A value for the HTTP header. This attribute is used in conjunction with the name attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "statuscode", + "description": "A number that sets the HTTP status code.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "charset", + "description": "The character encoding in which to encode the header value.\n\nFor more information on character encodings, see: .", + "default": false, + "type": "string", + "required": false + }, + { + "name": "statustext", + "description": "Text that explains the status code. This attribute is used in conjunction with the\n\tstatusCode attribute.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/htmlbody.json b/data/en/htmlbody.json new file mode 100644 index 000000000..00f082a5d --- /dev/null +++ b/data/en/htmlbody.json @@ -0,0 +1,45 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/htmlbody.html"}}, + "name": "htmlbody", + "description": "Writes the text specified in the text attribute to the 'body' section of a generated HTML page.\nThe cfhtmlbody tag can be useful for embedding JavaScript code, or placing other HTML tags that should go at the bottom\nof the page just before the closing body tag.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "text", + "description": "The text to add to the 'head' area of an HTML page. Everything inside the quotation marks is\nplaced in the 'head' section", + "default": false, + "type": "string", + "required": false + }, + { + "name": "variable", + "description": "Name of variable to contain the text for htmlbody.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "id", + "description": "ID of the snippet that is added, used to ensure that the same snippet will not be added more than once.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "force", + "description": "if set to true, it works even within a silent block", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "action", + "description": "possible actions are:\n\n- append (default): append text to the HTML head\n- read: return the text already set to HTML head\n- reset: reset/remove text already set to HTML head\n- write: write text to HTML head, overwrite already existing text in HTML head\n- flush: writes the buffer in the HTML head to the response stream", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/htmlhead.json b/data/en/htmlhead.json new file mode 100644 index 000000000..adb4845d2 --- /dev/null +++ b/data/en/htmlhead.json @@ -0,0 +1,45 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/htmlhead.html"}}, + "name": "htmlhead", + "description": "Writes the text specified in the text attribute to the 'head' section of a generated HTML page.\nThe cfhtmlhead tag can be useful for embedding JavaScript code, or placing other HTML tags such, as\nMETA, LINK, TITLE, or BASE in an HTML page header.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "text", + "description": "The text to add to the 'head' area of an HTML page. Everything inside the quotation marks is\nplaced in the 'head' section", + "default": false, + "type": "string", + "required": false + }, + { + "name": "force", + "description": "if set to true, it works even within a silent block", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "variable", + "description": "Name of variable to contain the text for htmlhead.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "id", + "description": "ID of the snippet that is added, used to ensure that the same snippet will not be added more than once.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "action", + "description": "possible actions are:\n\n- append (default): append text to the HTML head\n- read: return the text already set to HTML head\n- reset: reset/remove text already set to HTML head\n- write: write text to HTML head, overwrite already existing text in HTML head\n- flush: writes the buffer in the HTML head to the response stream\n", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/http.json b/data/en/http.json new file mode 100644 index 000000000..7c76ff710 --- /dev/null +++ b/data/en/http.json @@ -0,0 +1,284 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/http.html", + "notes": "For multipart with quoted boundary response, `filecontent` will be an array, see [LDEV-3545](https://luceeserver.atlassian.net/browse/LDEV-3545)" + }}, + "name": "http", + "description": "Lets you execute HTTP POST and GET operations on files.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "url", + "description": "Full URL of the host name or IP address of the server on which the file resides.\n\nThe URL must be an absolute URL, including the protocol (http or https) and hostname.\n\nIt may optionally contain a port number. Port numbers specified in the url attribute override the port attribute.\n", + "default": false, + "type": "string", + "required": true + }, + { + "name": "encodeurl", + "description": "if set to true (default value) URL encodes the value of the attribute \"URL\" if necessary (no double encoding is happening).\n\nThis setting has no influence on the values from httpparam type=\"url\", for this use the attribute \"encoded\" from httpparam\n\n**Try disabling this (i.e. false) if you are getting strange errors with API requests**\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "compression", + "description": "Informs the target webserver to disable compression for the response. Possible values are:\n\n- true (default): compression enabled\n- false: compression disabled\n- none (deprecated): use \"false\" instead", + "default": false, + "type": "string", + "required": false + }, + { + "name": "result", + "description": "return variable name, default \"cfhttp\"\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "addtoken", + "description": "if yes add urltoken as cookie", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "port", + "description": "The port number on the server from which the object is requested.\n\nDefault is 80.\n\nWhen used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.\n\nIf a port number is specified in the url attribute, the port value overrides the value of the port attribute.\n", + "default": false, + "type": "number", + "required": false + }, + { + "name": "method", + "description": "Supported methods\n\n- GET (default)\n- POST\n- HEAD\n- PUT\n- DELETE\n- OPTIONS\n- TRACE\n- PATCH\n\nUse GET to download a text or binary file or to create a query from the contents of a text file.\n\nUse POST to send information to a server page or a CGI program for processing.\n\nPOST requires the use of a [[tag-httpparam]] tag.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "username", + "description": "When required by a server, a valid `username`.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "When required by a server, a valid password.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "preauth", + "description": "If set to true (default), Lucee sends the basic authentication (username password) always (Preemptive Basic Authentication)\n\nIf set to false the authentication is only send when the server ask for it (status code 401).\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "multipart", + "description": "Tells Lucee to send all data specified by cfhttpparam type=\"formField\" tags as multipart form data, with a `Content-Type` of `multipart/form-data`.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "multiparttype", + "description": "This attribute has been deprecated, use instead the attribute \"multipart\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "getasbinary", + "description": "- false: If CFML does not recognize the response body type as text, convert it to a CFML object.\n- auto: If CFML does not recognize the response body type as text, convert it to CFML Binary type data.\n- true: always convert the response body content into CFML Binary type data, even if CFML recognizes the response body type as text.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "The name to assign to a query if the a query is constructed from a file.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "columns", + "description": "Specifies the column names for a query when creating a query as a result of a cfhttp GET.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "path", + "description": "The path to the directory in which a file is to be stored.\n\nIf a path is not specified in a POST or GET operation, a variable is created (cfhttp.fileContent) that you can use to display the results of the POST operation in a cfoutput.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "file", + "description": "The filename to be used for the file that is accessed.\n\nFor GET operations, defaults to the name specified in url.\n\nEnter path information in the path attribute.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "delimiter", + "description": "Used only when creating a query from an http request that returns data in a CSV format.\n\nThis value specifies the Field delimiter for the CSV data.\n\nOnly the first character is used.\n\nDefault is a comma.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "textqualifier", + "description": "Required for creating a query.\n\nIndicates the start and finish of a column.\n\nShould be appropriately escaped when embedded in a column.\n\nFor example, if the qualifier is a double quotation mark, it should be escaped as \"\"\"\".\n\nIf there is no text qualifier in the file, specify it as \" \".\n\nDefault is the double quotation mark (\").\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "resolveurl", + "description": "Yes or No.\n\nDefault is No.\n\nFor GET and POST operations, if Yes, page reference returned into the fileContent internal variable has its internal URLs fully resolved, including port number, so that links remain intact.\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "proxyserver", + "description": "Host name or IP address of a proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyport", + "description": "The port number on the proxy server from which the object is requested.\n\nDefault is 80.\n\nWhen used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.\n", + "default": false, + "type": "number", + "required": false + }, + { + "name": "proxyuser", + "description": "When required by a proxy server, a valid username.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxypassword", + "description": "When required by a proxy server, a valid password.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "useragent", + "description": "Use a custom `User-Agent` request header.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "throwonerror", + "description": "Boolean indicating whether to throw an exception that can be caught by using the [[tag-try]] and [[tag-catch]] tags.\n\nErrors include \n\n- a connection/response timeout\n- a http response status code which isn't between 200 and 299\n- a connection failure\n- unable to resolve hostname (i.e. DNS)\n- TLS/SSL problems\n\nThe default is YES.\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "redirect", + "description": "Boolean indicating whether to redirect execution or stop execution.\n\nThe default is Yes.\n\nIf set to No and throwOnError = \"yes\", execution stops if cfhttp fails, and the status code and associated error message are returned in the variable cfhttp.statuscode.\n\nTo see where execution would have been redirected, use the variable cfhttp.responseHeader[LOCATION]. The key LOCATION identifies the path of redirection.\n\nLucee will follow up to five redirections on a request. If this limit is exceeded, Lucee behaves as if redirect = \"no\".\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "timeout", + "description": "A value, in seconds.\n\nWhen a URL timeout is specified in the browser, the timeout attribute setting takes precedence over the Lucee Administrator timeout.\n\nThe server then uses the lesser of the URL timeout and the timeout passed in the timeout attribute, so that the request always times out before or at the same time as the page times out.\n\nIf there is no URL timeout specified, Lucee takes the lesser of the Lucee Administrator timeout and the timeout passed in the timeout attribute.\n\nIf there is no timeout set on the URL in the browser, no timeout set in the Lucee Administrator, and no timeout set with the timeout attribute, Lucee waits indefinitely for the cfhttp request to process.\n", + "default": false, + "type": "any", + "required": false + }, + { + "name": "charset", + "description": "Sets the charset for the call.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "firstrowasheaders", + "description": "sets if first row of csv is file", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "authtype", + "description": "Authentication type for a request with username and password, valid values are \"BASIC\" (default) and \"NTLM\"", + "default": false, + "type": "string", + "required": false + }, + { + "name": "workstation", + "description": "The workstation the authentication request is originating from.\n\nEssentially, the computer name for this machine. This attribute is only used when authentication type is \"NTLM\"\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "domain", + "description": "The domain to authenticate within. This attribute is only used when authentication type is \"NTLM\"", + "default": false, + "type": "string", + "required": false + }, + { + "name": "clientcert", + "description": "The full path to a PKCS12 format file that contains the client certificate for the request.", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "clientcertpassword", + "description": "Password used to decrypt the client certificate.", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "pooling", + "description": "Flag allowing to disable connection reuse on one off requests.", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "cachedwithin", + "description": "Supported values are:\n\n- String \"request\" (If original content was created within the current request, cached content data is used.)\n- a timespan (created with function CreateTimeSpan)\n\nTo use cached data, the tag must be called with the exact same arguments.\n", + "minimum_version": "obj", + "default": false, + "type": "object", + "required": false + }, + { + "name": "autocert", + "description": "When set to true, this attribute enables the automatic installation of SSL certificates for HTTPS connections, \nensuring the request can proceed without SSL certificate errors. \nThis is particularly useful for environments where certificates may not be pre-installed or are dynamically updated.", + "minimum_version": "boo", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/httpparam.json b/data/en/httpparam.json new file mode 100644 index 000000000..cf3415868 --- /dev/null +++ b/data/en/httpparam.json @@ -0,0 +1,52 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/httpparam.html"}}, + "name": "httpparam", + "description": "Required for cfhttp POST operations, cfhttpparam is used to specify the parameters necessary to\nbuild a cfhttp POST.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "A variable name for the data being passed.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "valid values are:\n\n- `header`: specifies an HTTP header.\n- `CGI`: specifies an HTTP header. Encodes the value depending on the attribute \"encoded\n- `body`: specifies the body of the HTTP request.\n- `XML`: identifies the request as having a content-type of text/xml. Specifies that the value attribute contains the body of the HTTP request. Used to send XML to the destination URL.\n- `file`: tells Lucee to send the contents of the specified file.\n- `URL`: specifies a URL query string name-value pair to append to the cfhttp url attribute.\n- `form,formField`: specifies a form field to send.\n- `cookie`: specifies a cookie to send as an HTTP header.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "value", + "description": "Specifies the value of the URL, FormField, Cookie, File, or CGI variable being passed.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "file", + "description": "Required for type = `File`.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "encoded", + "description": "Applies to type `cgi` and `url`, ignored for all other types.\n\nSpecifies whether to URL encode the values defined with the tag, but only if necessary (no double encoding).", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "mimetype", + "description": "Applies to File type; invalid for all other types.\n\nSpecifies the MIME media type of the file contents.\n\nThe content type can include an identifier for the character encoding of the file;\n\nFor example, `text/html; charset=ISO-8859-1` indicates that the file is HTML text in the ISO Latin-1 character encoding.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/if.json b/data/en/if.json new file mode 100644 index 000000000..00912a501 --- /dev/null +++ b/data/en/if.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/if.html"}}, + "name": "if", + "description": "Used with cfelse and cfelseif, cfif lets you create simple and compound conditional statements\nin CFML. The value in the cfif tag can be any expression.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "condition", + "description": "condition o the expression", + "default": false, + "type": "boolean", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/image.json b/data/en/image.json new file mode 100644 index 000000000..0f000cd92 --- /dev/null +++ b/data/en/image.json @@ -0,0 +1,157 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/image.html"}}, + "name": "image", + "description": "Lets you resize and add labels to GIF and JPEG format images.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "Action to execute.\n\n- border [[function-ImageAddBorder]]\n- captcha [[function-ImageCaptcha]]\n- convert\n- writetobrowser [[function-ImageWriteToBrowser]]\n- write [[function-ImageWrite]]\n- rotate [[function-ImageRotate]]\n- resize [[function-imageResize]]\n- read [[function-imageRead]]\n- info [[function-imageInfo]]", + "default": false, + "type": "string", + "required": false + }, + { + "name": "angle", + "description": "Angle in degrees to rotate the image.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "passthrough", + "description": "HTML attributes that are not explicitly supported by cfimage.\n\nIf you specify an attribute and value,\nthey are passed to the tag \"img\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "color", + "description": "Border color. Hexadecimal value or supported named color.\n\nFor a hexadecimal value, use the form \"#xxxxxx\" or \"xxxxxx\", where x = 0-9 or A-F; use two number signs or none.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "destination", + "description": "Absolute or relative pathname where the image output is written.\n\nThe image format is determined by the file extension.\n\nThe convert and write actions require a destination attribute.\n\nThe border, captcha, resize, and rotate actions require a name attribute or a destination attribute.\n\nYou can specify both.\n\nIf you do not enter a destination,\nthe CAPTCHA image is placed inline in the HTML output and displayed in the web browser.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "difficulty", + "description": "Level of complexity of the CAPTCHA text.\n\nSpecify one of the following levels of text distortion:\nlow, medium, high", + "default": false, + "type": "string", + "required": false + }, + { + "name": "fonts", + "description": "One or more valid fonts to use for the CAPTCHA text. Separate multiple fonts with commas.\n\nLucee supports only the system fonts that the JDK can recognize. For example, TTF fonts in the Windows directory are supported on Windows.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "fontsize", + "description": "font size of the text in the CAPTCHA image.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "format", + "description": "Format of the image displayed in the browser.\n\nIf you do not specify a format, the image is displayed in PNG format.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "height", + "description": "Height in pixels of the image.\n\nFor the resize attribute, you also can specify the height as a percentage.\n\nWhen you resize an image, if you specify a value for the width.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "isbase64", + "description": "Specifies whether the source is a Base64 string", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "name", + "description": "Name of the image variable to create.\n\nThe read action requires a name attribute.\n\nThe border, resize, and rotate actions require a name attribute or a destination attribute.\n\nYou can specify both.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "overwrite", + "description": "If the destination file already exists, Lucee generates an error if the overwrite action is not set to yes.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "quality", + "description": "Quality of the JPEG destination file. Applies only to files with an extension of JPG or JPEG.\n\nValid values are fractions that range from 0 through 1 (the lower the number, the lower the quality).", + "default": false, + "type": "number", + "required": false + }, + { + "name": "source", + "description": "source file", + "default": false, + "type": "any", + "required": false + }, + { + "name": "structname", + "description": "Name of the structure to be created.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "text", + "description": "Text string displayed in the CAPTCHA image. Use capital letters for better readability.\n\nDo not include spaces because users cannot detect them in the resulting CAPTCHA image.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "thickness", + "description": "Border thickness in pixels. The border is added to the outside edge of the source image, increasing the image area accordingly.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "width", + "description": "Width in pixels of the image.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "base64", + "description": "should action \"writetobrowser\" embed the source of the image as base64 encoded string, default is false.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "nometadata", + "description": "only used for action \"write\", if set to true, the meta data from a source image are NOT written to the destination image.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/imagecoderinfo.json b/data/en/imagecoderinfo.json new file mode 100644 index 000000000..27bbd0f22 --- /dev/null +++ b/data/en/imagecoderinfo.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/imagecoderinfo.html"}}, + "name": "imagecoderinfo", + "description": "Gives detailed information about all coder used by the image extension.", + "syntax": "imagecoderinfo( image )", + "returns": "struct", + "type": "function", + "params": [{ + "name": "image", + "description": "The image on which this operation is performed.", + "aliases": "name", + "type": "any", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/imagewritetobrowser.json b/data/en/imagewritetobrowser.json new file mode 100644 index 000000000..3e4ecb814 --- /dev/null +++ b/data/en/imagewritetobrowser.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/imagewritetobrowser.html"}}, + "name": "imagewritetobrowser", + "description": "Writes image to browser.", + "syntax": "imagewritetobrowser( image )", + "returns": "void", + "type": "function", + "params": [{ + "name": "image", + "description": "The image on which this operation is performed.", + "aliases": "name", + "type": "any", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/imap.json b/data/en/imap.json new file mode 100644 index 000000000..5ba3fdf86 --- /dev/null +++ b/data/en/imap.json @@ -0,0 +1,150 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/imap.html"}}, + "name": "imap", + "description": "Retrieves and deletes messages from an IMAP email server.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "connection", + "description": "label for a connection.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "server", + "description": "Host name biff.upperlip.com or IP address 192.1.2.225 of the Imap server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "port", + "description": "Defaults to the standard Imap port, 143.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "uid", + "description": "Specifies the unique ID or a comma-delimited list of Uids to retrieve or delete. If you set invalid Uids, then they are ignored.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "username", + "description": "If no user name is specified, the Imap connection is anonymous.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "Password that corresponds to user name.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "secure", + "description": "enables SSL for pop requests", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "action", + "description": "Specifies the IMAP action to perform.\n\n- getHeaderOnly\n- getAll\n- delete\n- open\n- close\n- markread\n- createfolder\n- deletefolder\n- renamefolder\n- listallfolders\n- movemail\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "Name for the index query.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "messagenumber", + "description": "Can be a comma-separated list of the message ids", + "default": false, + "type": "string", + "required": false + }, + { + "name": "attachmentpath", + "description": "Allows attachments to be written to the specified directory when action = \"getAll\". If an\ninvalid attachmentPath is specified, no attachment files are written to the server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "maxrows", + "description": "Sets the number of messages returned, starting with the number in the startRow attribute.\n\nThis attribute is ignored if messageNumber is specified.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "startrow", + "description": "Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if\nmessageNumber is specified.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "debug", + "description": "this attribute is deprecated and ignored, log control happens via the logging framework directly.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "generateuniquefilenames", + "description": "Boolean indicating whether to generate unique filenames for the files attached to an e-mail\nmessage to avoid naming conflicts when the files are saved. Default is NO.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "folder", + "description": "Folder for action, default is INBOX", + "default": false, + "type": "string", + "required": false + }, + { + "name": "newfolder", + "description": "Name of new folder, used by action renameFolder and moveMail", + "default": false, + "type": "string", + "required": false + }, + { + "name": "recurse", + "description": "Used for action listAllFolders", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "delimiter", + "description": "Character that separates uid list, The default value is comma(,).", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/import.json b/data/en/import.json new file mode 100644 index 000000000..5007ddfc4 --- /dev/null +++ b/data/en/import.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/import.html"}}, + "name": "import", + "description": "The tag `import` has a dual purpose, it can be used to import components with help of the attribute `path` \nor CFML/JSP custom tags with help of the attributes `prefix` and `taglib`.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "taglib", + "description": "Path to a custom tag library or a JSP tld\n\nAs cfimport is a compiler directive, Application.cfc mappings won't work, but mappings configured via the web admin will.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "prefix", + "description": "Prefix by which to access the imported custom CFML tags JSP tags.\n\nIf you import a CFML custom tag directory and specify an empty value, \"\", for this attribute, you can call the custom tags without using a prefix. You must specify and use a prefix for a JSP tag library.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "path", + "description": "path of CFC to be imported", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/include.json b/data/en/include.json new file mode 100644 index 000000000..f55136a03 --- /dev/null +++ b/data/en/include.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/include.html"}}, + "name": "include", + "description": "Lets you embed references to pages in CFML. You can embed cfinclude tags recursively.\nFor an additional method of encapsulating CFML", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "template", + "description": "A logical path to an existing page.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "cachedwithin", + "description": "possible values are:\nString \"request\": If original content was created within the current request, cached content data is used.\na timespan (created with function CreateTimeSpan): If original content date falls within the time span, cached content data is used.\n\nTo use cached data, the function must be called with the exact same arguments.", + "default": false, + "type": "object", + "required": false + }, + { + "name": "runonce", + "description": "if set to true, the given template is only included once within the current request.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/inquiryaisession.json b/data/en/inquiryaisession.json new file mode 100644 index 000000000..5e2f3cbad --- /dev/null +++ b/data/en/inquiryaisession.json @@ -0,0 +1,30 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/inquiryaisession.html"}}, + "name": "inquiryaisession", + "description": "Sends a question/message to an AI session and returns the response. The function maintains conversation context from previous interactions within the same session.\nThe response can either be returned as a complete string or streamed in chunks to a listener function for real-time processing.", + "syntax": "inquiryaisession( session, question )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "session", + "description": "The AI session object returned by LuceeCreateAISession(). This session maintains the conversation history and configuration settings like temperature and system message.", + "aliases": "aiSession", + "type": "any", + "required": true + }, + { + "name": "question", + "description": "The question or message to send to the AI. This can be plain text or structured data (like JSON) depending on how the session was configured in its system message.\n\nThe question becomes part of the conversation history and provides context for future interactions within the same session.", + "aliases": "message", + "type": "string", + "required": true + }, + { + "name": "listener", + "description": "A user-defined function that receives the response in chunks as they arrive from the AI. This enables real-time processing or display of the response.\n\nThe listener function should accept a single argument which will contain the response chunk.\n\nWhen a listener is provided, the function still returns the complete response as a string, but also streams each chunk to the listener as it arrives.", + "type": "function", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/inspecttemplates.json b/data/en/inspecttemplates.json new file mode 100644 index 000000000..6cd7d4dc8 --- /dev/null +++ b/data/en/inspecttemplates.json @@ -0,0 +1,13 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/inspecttemplates.html", + "minimum_version": "5.3", + "notes": "This only clears the cache for the **current** Application, plus all Server and Web Context mappings. \n\nOther per Application mappings are not affected\n" + }}, + "name": "inspecttemplates", + "description": "Flag all the cfml code (cfm, cfcs) in the cache of compiled code (aka the Page Pool) to be checked once for any changes.", + "syntax": "inspecttemplates( )", + "returns": "boolean", + "type": "function", + "params": [] +} \ No newline at end of file diff --git a/data/en/interface.json b/data/en/interface.json new file mode 100644 index 000000000..4d1fb45d3 --- /dev/null +++ b/data/en/interface.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/interface.html"}}, + "name": "interface", + "description": "Defines an interface that consists of a set of signatures for functions.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "displayname", + "description": "A value to be displayed when using introspection to show a descriptive name for the interface.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "extends", + "description": "A comma-delimited list of one or more interfaces that this interface extends.\n\nAny CFC that implements an interface must also implement all the functions in the interfaces specified by this property.\n\nIf an interface extends another interface, and the child interface specifies a function with the same name as one in the parent interface, both functions must have the same attributes; otherwise it generates an error.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "hint", + "description": "Text to be displayed when using introspection to show information about the interface.\n\nThe hint attribute value follows the syntax line in the function description.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/internalrequest.json b/data/en/internalrequest.json new file mode 100644 index 000000000..a4e4ba3fd --- /dev/null +++ b/data/en/internalrequest.json @@ -0,0 +1,80 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/internalrequest.html", + "minimum_version": "6.0" + }}, + "name": "internalrequest", + "description": "Makes a request to the CFML Engine internally.", + "syntax": "internalrequest( template )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "template", + "description": "Template path (script name) for the request (example:/test/index.cfm).", + "type": "string", + "required": true + }, + { + "name": "method", + "description": "method of the request (GET,POST,PUT,DELETE ...)", + "default": "get", + "type": "string", + "required": false + }, + { + "name": "urls", + "description": "URL scope passed to the request (query string). This can be a struct or a string following this format [name1=value1&name2=value2].", + "aliases": "url", + "type": "any", + "required": false + }, + { + "name": "forms", + "description": "FORM scope passed to the request.This can be a struct or a string following this format [name1=value1&name2=value2].", + "aliases": "form", + "type": "any", + "required": false + }, + { + "name": "cookies", + "description": "Cookie scope passed to the request", + "aliases": "cookie", + "type": "struct", + "required": false + }, + { + "name": "headers", + "description": "Request header entries passed to the request", + "aliases": "header", + "type": "struct", + "required": false + }, + { + "name": "body", + "description": "body to send with the request", + "type": "any", + "required": false + }, + { + "name": "charset", + "description": "charset used for the request, if not set the web charset is used.", + "type": "string", + "required": false + }, + { + "name": "addToken", + "description": "if yes add urlToken as cookie", + "default": "false", + "type": "boolean", + "required": false + }, + { + "name": "throwonerror", + "description": "if true (default) and the called page throws an exception, that exception is also thrown within the caller request. If false it is catched and only reported in the resulting struct.", + "default": "true", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/interruptthread.json b/data/en/interruptthread.json new file mode 100644 index 000000000..a7f7d3f40 --- /dev/null +++ b/data/en/interruptthread.json @@ -0,0 +1,14 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/interruptthread.html"}}, + "name": "interruptthread", + "description": "Interrupts a specified thread by setting its interrupt status flag.\nThis function sets the interrupt status flag on a CFThread. The behavior depends on the thread's current state:\n- If the thread is blocked in a ThreadJoin or sleep method call: its interrupt status will be cleared and it will \nreceive an InterruptedException\n- If the thread is executing a long-running operation with interrupt checks: the operation may terminate early\n- If the thread is not alive: the interrupt request may have no effect", + "syntax": "interruptthread( )", + "returns": "any", + "type": "function", + "params": [{ + "name": "name", + "description": "The name of the thread to interrupt. If omitted or empty, the current thread will be interrupted.", + "type": "string", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/invokeargument.json b/data/en/invokeargument.json new file mode 100644 index 000000000..489e424f7 --- /dev/null +++ b/data/en/invokeargument.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/invokeargument.html"}}, + "name": "invokeargument", + "description": "Argument for the Invoke Tag", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "name of the argument", + "default": false, + "type": "string", + "required": true + }, + { + "name": "value", + "description": "value of the argument", + "default": false, + "type": "any", + "required": true + }, + { + "name": "omit", + "description": "Enables you to omit a parameter when invoking a web service", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/isflushed.json b/data/en/isflushed.json new file mode 100644 index 000000000..28ae9874a --- /dev/null +++ b/data/en/isflushed.json @@ -0,0 +1,12 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/isflushed.html", + "minimum_version": "6.1" + }}, + "name": "isflushed", + "description": "returns true if the response stream was already flushed.", + "syntax": "isflushed( )", + "returns": "boolean", + "type": "function", + "params": [] +} \ No newline at end of file diff --git a/data/en/iswithintransaction.json b/data/en/iswithintransaction.json new file mode 100644 index 000000000..3400eca27 --- /dev/null +++ b/data/en/iswithintransaction.json @@ -0,0 +1,12 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/iswithintransaction.html", + "minimum_version": "5.3" + }}, + "name": "iswithintransaction", + "description": "Determines whether the current thread is within a transaction block or not.", + "syntax": "iswithintransaction( )", + "returns": "boolean", + "type": "function", + "params": [] +} \ No newline at end of file diff --git a/data/en/ldap.json b/data/en/ldap.json new file mode 100644 index 000000000..334556981 --- /dev/null +++ b/data/en/ldap.json @@ -0,0 +1,185 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/ldap.html"}}, + "name": "ldap", + "description": "Provides an interface to LDAP Lightweight Directory Access Protocol\ndirectory servers like the Netscape Directory Server.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "returnasbinary", + "description": "A comma-delimited list of columns that are to be returned as binary values.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "server", + "description": "Host name \"biff.upperlip.com\" or IP address \"192.1.2.225\" of the LDAP server.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "port", + "description": "Port defaults to the standard LDAP port, 389.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "usetls", + "description": "use a secure connection. (but try secure=\"CFSSL_BASIC\" instead)", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "username", + "description": "If no user name is specified, the LDAP connection is anonymous.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "secure", + "description": "The type of security to use\n\n- CFSSL_BASIC\n- CFSSL_CLIENT_AUTH\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "used when username is defined", + "default": false, + "type": "string", + "required": false + }, + { + "name": "action", + "description": "Specifies the LDAP action.\n\n- add\n- delete\n- modifydn\n- modify\n- query\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "The name you assign to the LDAP query.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "Specifies the maximum amount of time, in seconds, to wait for LDAP processing. Defaults to\n60 seconds.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "maxrows", + "description": "Specifies the maximum number of entries for LDAP queries.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "start", + "description": "Specifies the distinguished name of the entry to be used to start the search.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "scope", + "description": "Specifies the scope of the search from the entry specified in the Start attribute\nfor action = \"Query\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "attributes", + "description": "Required if action = \"Query\", \"Add\", \"ModifyDN\", or \"Modify\"\nFor queries: comma-delimited list of attributes to return. For\nqueries, to get all attributes, specify \"*\".\n\nIf action = \"add\" or \"modify\", you can specify a list of update\ncolumns. Separate attributes with a semicolon.\n\nIf action = \"ModifyDN\", CFML passes attributes to the\nLDAP server without syntax checking.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filter", + "description": "Search criteria for action = \"Query\".\n\nList attributes in the form:\n\"(attribute operator value)\" Example: \"(sn = Smith)\"", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filterfile", + "description": "this attribute is deprecated and no longer supported.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "sort", + "description": "Indicates the attribute or attributes by which to sort query results. Use a comma to separate attributes.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "sortcontrol", + "description": "Specifies how to sort query results.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "dn", + "description": "Specifies the distinguished name for update actions.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "startrow", + "description": "Used in conjunction with action = \"Query\". Specifies the first row of the LDAP query to insert\ninto the query. The default is 1.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "modifytype", + "description": "Indicates whether to add, delete, or replace an attribute in a multi-value list of attributes.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "rebind", + "description": "If you set rebind to Yes, cfldap attempts to rebind the referral callback and reissue the query\nby the referred address using the original credentials. The default is No, which means referred\nconnections are anonymous.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "referral", + "description": "Number of hops allowed in a referral. A value of 0 disables referred addresses for LDAP; no data is returned.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "separator", + "description": "Specifies the character that cfldap uses to separate attribute values in multi-value attributes. This character is used by the query, add, and modify action attributes, and\nby cfldap to output multi-value attributes. The default character is the comma (,).", + "default": false, + "type": "string", + "required": false + }, + { + "name": "delimiter", + "description": "Specifies the character that cfldap uses to separate multiple attribute name/value pairs when more than one attribute is specified in the attribute attribute or the attribute that you want to use has the default delimiter character, which is the semicolon (;), such as mgrpmsgrejecttext;lang-en. The delimiter character is used by the query, add, and\nmodify action attributes, and is used by cfldap to output multi-value attributes", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/listgetduplicates.json b/data/en/listgetduplicates.json new file mode 100644 index 000000000..150bc30e2 --- /dev/null +++ b/data/en/listgetduplicates.json @@ -0,0 +1,40 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/listgetduplicates.html", + "minimum_version": "7.0" + }}, + "name": "listgetduplicates", + "description": "Removes duplicate values from list.", + "syntax": "listgetduplicates( list )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "list", + "description": "a string list", + "type": "string", + "required": true + }, + { + "name": "delimiters", + "description": "Characters that separate list elements. The default value is comma.", + "default": ",", + "aliases": "delimiter", + "type": "string", + "required": false + }, + { + "name": "ignoreCase", + "description": "if set to true, the duplicate value test will not be case sensitive", + "default": "false", + "type": "boolean", + "required": false + }, + { + "name": "includeEmptyFields", + "description": "if set to true, empty values are included as well", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/listqualifiedtoarray.json b/data/en/listqualifiedtoarray.json new file mode 100644 index 000000000..f156750c4 --- /dev/null +++ b/data/en/listqualifiedtoarray.json @@ -0,0 +1,49 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/listqualifiedtoarray.html", + "minimum_version": "5.3" + }}, + "name": "listqualifiedtoarray", + "description": "Copies the elements of a list to an array.", + "syntax": "listqualifiedtoarray( list )", + "returns": "array", + "type": "function", + "params": [ + { + "name": "list", + "description": "a string list", + "type": "string", + "required": true + }, + { + "name": "delimiter", + "description": "a single character that separate list elements.", + "default": ",", + "aliases": "delimiters", + "type": "string", + "required": false + }, + { + "name": "qualifier", + "description": "a single character before and after the list elements.", + "default": "\"", + "aliases": "qualifiers", + "type": "string", + "required": false + }, + { + "name": "qualifierRequired", + "description": "if set to true, all values need to have qualifier (quotes) around them.", + "default": "false", + "type": "boolean", + "required": false + }, + { + "name": "includeEmptyFields", + "description": "if set to true, empty values are included as well", + "default": "false", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/loadaisession.json b/data/en/loadaisession.json new file mode 100644 index 000000000..8c7c76194 --- /dev/null +++ b/data/en/loadaisession.json @@ -0,0 +1,23 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/loadaisession.html"}}, + "name": "loadaisession", + "description": "Restores an AI session from a serialized JSON string or struct. This function recreates an AI session with:\n- Original configuration settings (temperature, limits, timeouts)\n- Complete conversation history\n- System message prompt\nThe function supports loading sessions by:\n- AI engine name\n- Engine ID (using `id:` prefix)\n- Default engine (using `default:` prefix)\nThis function pairs with `SerializeAISession()` to provide persistence for AI conversations across requests or application restarts.", + "syntax": "loadaisession( name, data )", + "returns": "any", + "type": "function", + "params": [ + { + "name": "name", + "description": "Specifies which AI endpoint configuration to use. Can be provided in two formats:\n1. Direct endpoint name:\nThe name of an endpoint as defined in the Lucee Administrator (similar to how datasource names work)\n2. Default reference:\nUsing the format \"default:category\" to use the endpoint configured as the default for that specific category in the Lucee Administrator.\nCurrently supported default categories:\n- exception: For exception analysis\n- documentation: For documentation tasks\nThe endpoint configurations and their default category assignments are managed in the Lucee Administrator.", + "aliases": "aiName,nameAI", + "type": "string", + "required": true + }, + { + "name": "data", + "description": "The serialized AI session data, which can be provided as either:\n1. A JSON string previously generated by `SerializeAISession()`\n2. A struct containing session configuration and conversation history\nMust contain the following keys:\n- `temperature`: The temperature setting for the AI responses\n- `limit`: The conversation size limit\n- `connectionTimeout`: Connection timeout in milliseconds\n- `socketTimeout`: Socket timeout in milliseconds \n- `systemMessage`: (Optional) System message that guides AI behavior\n- `history`: Array of conversation exchanges (questions and answers)\nIncomplete or improperly formatted data may cause initialization errors.", + "type": "any", + "required": true + } + ] +} \ No newline at end of file diff --git a/data/en/lock.json b/data/en/lock.json new file mode 100644 index 000000000..5c56f8830 --- /dev/null +++ b/data/en/lock.json @@ -0,0 +1,52 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/lock.html"}}, + "name": "lock", + "description": "Provides two types of locks to ensure the integrity of shared data: Exclusive lock and Read-only lock.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "timeout", + "description": "Specifies the maximum amount of time, in seconds, to wait to obtain a lock.\n\nIf a lock can be obtained within the specified period, execution continues inside the body of the tag. Otherwise, the behavior depends on the value of the throwOnTimeout attribute.", + "default": false, + "type": "object", + "required": false + }, + { + "name": "scope", + "description": "Specifies the scope as one of the following: Application, Server, or Session.\n\nThis attribute is mutually exclusive with the name attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "Specifies the name of the lock.\n\nOnly one request can execute inside a cflock tag with a given name. Therefore, providing the name attribute allows for synchronizing access to resources from \tdifferent parts of an application. Lock names are global to a server. They are shared between applications and user sessions, but not across clustered servers.\n\nThis attribute is mutually exclusive with the scope attribute. Therefore, do not specify the scope attribute and the name attribute in a tag. The value of name cannot be an empty string.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "throwontimeout", + "description": "Yes or No. Specifies how timeout conditions are handled.\n\nIf the value is Yes, an exception is generated to provide notification of the timeout.\n\nIf the value is No, execution continues past the cfclock tag. Default is Yes.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "type", + "description": "readOnly or Exclusive. Specifies the type of lock: read-only or exclusive. Default is Exclusive.\n\nA read-only lock allows more than one request to read shared data. An exclusive lock allows only one request to read or write to shared data.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "result", + "description": "Specifies a name for the structure in which cflock returns the `statusCode` and `ExecutionTime` variables.\n\nDefault variable is \"cflock\".\n", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/logallthreads.json b/data/en/logallthreads.json new file mode 100644 index 000000000..ea670e39c --- /dev/null +++ b/data/en/logallthreads.json @@ -0,0 +1,33 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/logallthreads.html", + "minimum_version": "6.2" + }}, + "name": "logallthreads", + "description": "Creates detailed thread stack trace logs in JSONL format for performance analysis and debugging.\nThis function captures stack traces from all running threads at specified intervals for a given duration.\nIt executes asynchronously, returning immediately after starting the logging process, making it ideal\nfor analyzing specific code segments by initiating logging just before the target code execution.\nThe output format is JSONL (JSON Lines), where each line represents a separate JSON object containing:\n- Timestamp offset in milliseconds from 1/1/1970 00:00:00 UTC (Unix 0)\n- Complete stack trace of each thread's current location\nThis data can be used for:\n- Performance bottleneck identification\n- Thread behavior analysis\n- Deadlock detection\n- Resource usage patterns", + "syntax": "logallthreads( path )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "path", + "description": "Full file path where the log will be written. The file should have a `.jsonl` extension\nfor proper identification as a JSON Lines format file. The function will create the file\nif it doesn't exist, or append to it if it does.\n\nExample: `/var/log/lucee/thread_analysis.jsonl`", + "type": "string", + "required": true + }, + { + "name": "interval", + "description": "The time interval (in milliseconds) between stack trace captures. Lower values provide\nmore detailed analysis but generate larger log files and may impact performance.\n\nRecommended ranges:\n\n- 1-10ms: Very detailed analysis, higher overhead\n- 10-100ms: Balanced detail and performance\n- 100ms+: Lower detail, minimal performance impact", + "default": "0", + "type": "number", + "required": false + }, + { + "name": "duration", + "description": "Total duration (in milliseconds) for which the function will collect thread data.\n\nAfter this period, logging automatically stops.\n\nCommon durations:\n\n- 1000-5000ms: Quick snapshots\n- 10000ms: Standard analysis period\n- 30000ms+: Extended analysis for complex operations", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/login.json b/data/en/login.json new file mode 100644 index 000000000..d9fae35b3 --- /dev/null +++ b/data/en/login.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/login.html"}}, + "name": "login", + "description": "A container for user login and authentication code.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "idletimeout", + "description": "Time interval, in seconds, after which Lucee logs off the user.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "applicationtoken", + "description": "The login that applies to the application. To let users log in to only one application, specify a unique value for that application. To let users log in to multiple applications, specify the same value for those applications. If you do not set a value for the applicationtoken attribute, the default value is CFAUTHORIZATION_applicationname.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cookiedomain", + "description": "Domain of the cookie that is used to mark a user as logged in. Use this attribute to enable a user login cookie to work with multiple clustered servers in the same domain.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/loginuser.json b/data/en/loginuser.json new file mode 100644 index 000000000..6a7c1a219 --- /dev/null +++ b/data/en/loginuser.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/loginuser.html"}}, + "name": "loginuser", + "description": "Identifies an authenticated user to ColdFusion. Specifies the user ID and roles. Used within a cflogin tag.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "The Name of the User", + "default": false, + "type": "string", + "required": true + }, + { + "name": "password", + "description": "The Password of the User", + "default": false, + "type": "string", + "required": true + }, + { + "name": "roles", + "description": "The Roles of the user in comma separated form.\n", + "default": false, + "type": "any", + "required": true + } + ] +} \ No newline at end of file diff --git a/data/en/logout.json b/data/en/logout.json new file mode 100644 index 000000000..76adb14cd --- /dev/null +++ b/data/en/logout.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/logout.html"}}, + "name": "logout", + "description": "Logs the current user out. Removes knowledge of the user ID, password, and roles from the server.\nIf you do not use this tag, the user is automatically logged out when the session ends.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/loop.json b/data/en/loop.json new file mode 100644 index 000000000..a1306cba5 --- /dev/null +++ b/data/en/loop.json @@ -0,0 +1,178 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/loop.html"}}, + "name": "loop", + "description": "Looping is a very powerful programming technique that lets you repeat a set of instructions or\ndisplay output repeatedly until one or more conditions are met. cfloop supports five types of loops.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "index", + "description": "Index value. Lucee sets it to from value and increments or decrements by step value, until it equals to value.\n\nWhen looping over a Struct/Collection:\n\n- When the Item attribute is also defined, the variable assigned to the Index attribute will contain the value of the Struct's Key/Value pair (otherwise, it will always contain the Key value)\n- When only the Index or Item attribute is defined, the variable will always contain the Key value.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "from", + "description": "Beginning value of index.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "to", + "description": "Ending value of index.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "step", + "description": "Step by which to increment or decrement the index value.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "condition", + "description": "Condition that controls the loop.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "query", + "description": "Query that controls the loop. This can be a variable name or the query itself.", + "default": false, + "type": "object", + "required": false + }, + { + "name": "startrow", + "description": "First row of query that is included in the loop.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "endrow", + "description": "Last row of query that is included in the loop. You cannot use this attribute together with the attribute maxRows.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "maxrows", + "description": "Specifies the maximum number of rows to display in the output section. You cannot use this attribute together with the attribute endrow.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "list", + "description": "A list, variable, or file name; contains a list. Used with the index attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "array", + "description": "An array.", + "default": false, + "type": "array", + "required": false + }, + { + "name": "delimiters", + "description": "Character(s) that separates items in list", + "default": false, + "type": "string", + "required": false + }, + { + "name": "collection", + "description": "Collection to loop over. Used with the item attribute.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "struct", + "description": "struct to loop over", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "item", + "description": "Key for the collection", + "default": false, + "type": "string", + "required": false + }, + { + "name": "file", + "description": "file path", + "default": false, + "type": "string", + "required": false + }, + { + "name": "characters", + "description": "The number of characters to read during each iteration of the loop from the file specified in the file attribute.\nIf the value of the characters attribute is more than the number of characters in the file,\nLucee uses the number of characters in the file.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "startline", + "description": "start line", + "default": false, + "type": "number", + "required": false + }, + { + "name": "endline", + "description": "end line", + "default": false, + "type": "number", + "required": false + }, + { + "name": "charset", + "description": "charset for read the file", + "default": false, + "type": "string", + "required": false + }, + { + "name": "group", + "description": "Specifies the query column to use when you group sets of records together to send as an e-mail\nmessage. For example, if you send a set of billing statements to customers, you might group on\n\"Customer_ID.\" The group attribute, which is case sensitive, eliminates adjacent duplicates when the\ndata is sorted by the specified field. See the Usage section for exceptions.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "groupcasesensitive", + "description": "Boolean indicating whether to group with regard to case or not. The default value is NO;\ncase is considered while grouping. If the query attribute specifies a query object that was generated\nby a case-insensitive SQL query, set the groupCaseSensitive attribute to NO to keep the recordset\nintact.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "label", + "description": "used to address this loop from a \"break\" or \"continue\" statement (instead of the nearest one).", + "default": false, + "type": "string", + "required": false + }, + { + "name": "times", + "description": "used for a simple loop that is looping n times", + "default": false, + "type": "numeric", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/lslcase.json b/data/en/lslcase.json new file mode 100644 index 000000000..4e0e84f36 --- /dev/null +++ b/data/en/lslcase.json @@ -0,0 +1,25 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/lslcase.html", + "minimum_version": "6.1" + }}, + "name": "lslcase", + "description": "Converts the alphabetic characters in a specified string to lowercase, respecting locale-specific casing rules. This is particularly important for languages where the standard lowercase conversion rules do not apply, ensuring accurate and culturally correct text processing. The function defaults to the current page's locale if no locale is specified.", + "syntax": "lslcase( string )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "string", + "description": "The string to be converted to lowercase. This parameter can accept either a string literal or a variable that holds the string content.", + "type": "string", + "required": true + }, + { + "name": "locale", + "description": "Optional. Allows specifying a different locale for the conversion, superseding the page's default locale. This argument accepts a locale identifier, such as \"fr-CA\" for Canadian French or \"de-DE\" for German in Germany.", + "type": "locale", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/lsucase.json b/data/en/lsucase.json new file mode 100644 index 000000000..dae967143 --- /dev/null +++ b/data/en/lsucase.json @@ -0,0 +1,25 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/lsucase.html", + "minimum_version": "6.1" + }}, + "name": "lsucase", + "description": "Converts the alphabetic characters in a specified string to uppercase, respecting locale-specific casing rules", + "syntax": "lsucase( string )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "string", + "description": "The string to be converted to uppercase. This can be a direct string value or a variable that contains the string.", + "type": "string", + "required": true + }, + { + "name": "locale", + "description": "Optional. Specifies the locale to use for the conversion, overriding the default locale of the page. This should be a locale code string (e.g., \"en-US\" for American English or \"tr-TR\" for Turkish).", + "type": "locale", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/luceeaigetmetadata.json b/data/en/luceeaigetmetadata.json new file mode 100644 index 000000000..8af1006bd --- /dev/null +++ b/data/en/luceeaigetmetadata.json @@ -0,0 +1,24 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/luceeaigetmetadata.html"}}, + "name": "luceeaigetmetadata", + "description": "Retrieves metadata about a configured AI endpoint. \nReturns information about the endpoint's configuration, \nand optionally detailed information about available models and associated files.", + "syntax": "luceeaigetmetadata( name )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "name", + "description": "The name of the AI endpoint to get metadata for. Can be either:\n\n1. A direct endpoint name as configured in the Lucee Administrator\n2. A default reference (e.g., \"default:exception\") which will resolve to the configured default endpoint for that category", + "aliases": "aiName,nameAI,session", + "type": "any", + "required": true + }, + { + "name": "detailed", + "description": "When true, includes additional detailed information:\n\n- Models: List of available models with their names, labels, descriptions, and custom settings\n- Files: For file-capable engines, lists associated files with their IDs, purposes, sizes, creation dates, and status information", + "default": "false", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/luceeaihas.json b/data/en/luceeaihas.json new file mode 100644 index 000000000..36617441a --- /dev/null +++ b/data/en/luceeaihas.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/luceeaihas.html"}}, + "name": "luceeaihas", + "description": "Checks whether a specific AI endpoint is configured and available for use.", + "syntax": "luceeaihas( name )", + "returns": "boolean", + "type": "function", + "params": [{ + "name": "name", + "description": "The name of the AI endpoint to check. Can be either:\n\n1. A direct endpoint name as configured in the Lucee Administrator\n2. A default reference (e.g., \"default:exception\") which will check if a default endpoint is configured for that category", + "aliases": "aiName,nameAI", + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/luceecreateaisession.json b/data/en/luceecreateaisession.json new file mode 100644 index 000000000..79617f79f --- /dev/null +++ b/data/en/luceecreateaisession.json @@ -0,0 +1,39 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/luceecreateaisession.html"}}, + "name": "luceecreateaisession", + "description": "Creates a new AI session for interaction with Large Language Models (LLMs). \nThe session maintains conversation history and context between interactions. \nEach session can be configured with different parameters to optimize for specific use cases like code analysis, content generation, or data processing.\nCommon usage patterns:\n- Exception analysis and debugging assistance\n- Code documentation generation\n- Query optimization suggestions\n- Security review assistance\n- Performance optimization recommendations\nThe session persists until explicitly terminated or the application restarts.", + "syntax": "luceecreateaisession( name )", + "returns": "object", + "type": "function", + "params": [ + { + "name": "name", + "description": "Specifies which AI endpoint configuration to use. Can be provided in two formats:\n\n1. Direct endpoint name:\nThe name of an endpoint as defined in the Lucee Administrator (similar to how datasource names work)\n2. Default reference:\nUsing the format \"default:category\" to use the endpoint configured as the default for that specific category in the Lucee Administrator.\n\nCurrently supported default categories:\n\n- exception: For exception analysis\n- documentation: For documentation tasks\n\nThe endpoint configurations and their default category assignments are managed in the Lucee Administrator.", + "aliases": "aiName,nameAI", + "type": "string", + "required": true + }, + { + "name": "systemMessage", + "description": "Initial instruction set that defines the AI's behavior and expertise for this session. This message sets the context and rules for all subsequent interactions.\n\nBest practices:\n\n- Be specific about the AI's role and expertise\n- Define output format requirements clearly\n- Include any necessary constraints or rules\n- Specify error handling preferences\n- Define response structure expectations\n\nThe system message persists throughout the session and influences all responses.", + "aliases": "initalMesssage,message", + "type": "string", + "required": false + }, + { + "name": "limit", + "description": "Maximum number of question-answer pairs to keep in the conversation history. Once reached, older messages will be removed.\nConsider:\n\n- Higher limits provide more context but consume more memory\n- Lower limits are more memory efficient but may lose important context\n- For complex analysis tasks, consider limits of 10-20\n- For simple Q&A, limits of 5-10 may suffice", + "default": "50", + "aliases": "conversationHistoryLimit", + "type": "numeric", + "required": false + }, + { + "name": "temperature", + "description": "Controls response randomness (0.0 to 1.0). Lower values make responses more focused and deterministic, higher values make them more creative and varied.\n\nRecommended settings:\n\n- 0.0-0.3: Technical analysis, debugging, code review\n- 0.3-0.5: Documentation generation, error explanations\n- 0.5-0.7: General purpose interactions\n- 0.7-1.0: Creative content generation\n\nFor exception analysis and debugging, lower temperatures (0.2-0.3) are recommended for more consistent and precise responses.", + "default": "0.7", + "type": "numeric", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/luceeinquiryaisession.json b/data/en/luceeinquiryaisession.json new file mode 100644 index 000000000..053d89327 --- /dev/null +++ b/data/en/luceeinquiryaisession.json @@ -0,0 +1,30 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/luceeinquiryaisession.html"}}, + "name": "luceeinquiryaisession", + "description": "Sends a question/message to an AI session and returns the response. The function maintains conversation context from previous interactions within the same session.\nThe response can either be returned as a complete string or streamed in chunks to a listener function for real-time processing.", + "syntax": "luceeinquiryaisession( session, question )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "session", + "description": "The AI session object returned by LuceeCreateAISession(). This session maintains the conversation history and configuration settings like temperature and system message.", + "aliases": "aiSession", + "type": "any", + "required": true + }, + { + "name": "question", + "description": "The question or message to send to the AI. This can be plain text or structured data (like JSON) depending on how the session was configured in its system message.\nThe question becomes part of the conversation history and provides context for future interactions within the same session.", + "aliases": "message", + "type": "string", + "required": true + }, + { + "name": "listener", + "description": "A user-defined function that receives the response in chunks as they arrive from the AI. This enables real-time processing or display of the response.\nThe listener function should accept a single argument which will contain the response chunk.\nWhen a listener is provided, the function still returns the complete response as a string, but also streams each chunk to the listener as it arrives.", + "type": "function", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/mail.json b/data/en/mail.json new file mode 100644 index 000000000..cb9981e1e --- /dev/null +++ b/data/en/mail.json @@ -0,0 +1,248 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/mail.html"}}, + "name": "mail", + "description": "Sends e-mail messages by an SMTP server.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "from", + "description": "The sender of the e-mail message.", + "default": false, + "type": "object", + "required": true + }, + { + "name": "to", + "description": "The name of the e-mail message recipient.", + "default": false, + "type": "object", + "required": true + }, + { + "name": "cc", + "description": "Indicates addresses to copy the e-mail message to; \"cc\" stands for \"carbon copy.\"", + "default": false, + "type": "object", + "required": false + }, + { + "name": "bcc", + "description": "Indicates addresses to copy the e-mail message to, without listing them in the message header.\n\n\"bcc\" stands for \"blind carbon copy.\"", + "default": false, + "type": "object", + "required": false + }, + { + "name": "replyto", + "description": "Address(es) to which the recipient is directed to send replies.", + "default": false, + "type": "object", + "required": false + }, + { + "name": "failto", + "description": "Address to which mailing systems should send delivery failure notifications. Sets the mail envelope Return-Path value.\n", + "default": false, + "type": "object", + "required": false + }, + { + "name": "subject", + "description": "The subject of the mail message. This field may be driven dynamically on\na message-by-message basis", + "default": false, + "type": "string", + "required": true + }, + { + "name": "type", + "description": "Specifies extended type attributes for the message.\n\n- text\n- plain\n- html\n- text/plain\n- text/html", + "default": false, + "type": "string", + "required": false + }, + { + "name": "maxrows", + "description": "Specifies the maximum number of e-mail messages to send.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "mimeattach", + "description": "Specifies the path of the file to be attached to the e-mail message. An attached file\nis MIME-encoded.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "listener", + "description": "Listener for the mail. the listener can have 2 (optional) functions, \"before\" and \"after\" that get triggered before and after sending the mail.\n\nThe functions get all data about the mail.\n\nListener is only used when `async` (spoolEnable) is set to true.\n\nThis attribute overwrites any mail listener defined in the `application.cfc/cfapplication`.\n\nThe \"before\" function can also modify some data, by returning a struct containing the following keys:\n\n`[ from, to, bcc, cc, replyTo, failTo, subject, charset]`\n\nthe listener can be a component looking like this:\n\n```\ncomponent {\n function before( lastExecution, nextExecution, created, id, type, detail,\n tries, remainingTries, closed, caller, advanced ){}\n function after( lastExecution, nextExecution, created, id, type, detail, tries,\n remainingTries, closed, caller, advanced, passed, exception ){}\n}\n```\n\na struct looking like this:\n\n`component {before:function(...){}, after:function(...){}}`", + "default": false, + "type": "any", + "required": false + }, + { + "name": "query", + "description": "The name of the cfquery from which to draw data for message(s) to send. Specify this\nattribute to send more than one mail message, or to send the results of a query within a message.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "group", + "description": "Specifies the query column to use when you group sets of records together to send as an e-mail\nmessage. For example, if you send a set of billing statements to customers, you might group on\n\"Customer_ID.\" The group attribute, which is case sensitive, eliminates adjacent duplicates when the\ndata is sorted by the specified field. See the Usage section for exceptions.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "groupcasesensitive", + "description": "Boolean indicating whether to group with regard to case or not. The default value is NO;\ncase is considered while grouping. If the query attribute specifies a query object that was generated\nby a case-insensitive SQL query, set the groupCaseSensitive attribute to NO to keep the recordset\nintact.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "startrow", + "description": "Specifies the row in the query to start from.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "server", + "description": "The address of the SMTP server to use for sending messages. If no server is specified, the\nserver name specified in the Lucee Administrator is used.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "port", + "description": "The TCP/IP port on which the SMTP server listens for requests. This is normally 25.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "mailerid", + "description": "Specifies a mailer ID to be passed in the X-Mailer SMTP header, which identifies the mailer\napplication.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "The number of seconds to wait before timing out the connection to the SMTP server.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "username", + "description": "A user name to send to SMTP servers that require authentication. Requires a password attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "A password to send to SMTP servers that require authentication. Requires a username attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "wraptext", + "description": "Specifies the maximum line length, in characters of the mail text. If a line has more than the specified number of characters, replaces the last white space character, such as a tab or space, preceding the specified position with a line break. If there are no white space characters, inserts a line break at the specified position. A common value for this attribute is 72.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "charset", + "description": "Character encoding of the mail message", + "default": false, + "type": "string", + "required": false + }, + { + "name": "async", + "description": "if set to true, the mail is sent asynchronously by the Lucee Task manager (with multiple tries),\nif set to false the mail is sent in the same thread that executes the request, which is useful for troubleshooting because you get an error message if there is one.\n\nThis setting overrides the setting with the same name in the Lucee Administrator.\n\nThis attribute replaces the old \"spoolenable\" attribute which is still supported as an alias.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "usetls", + "description": "Whether to use Transport Level Security.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "priority", + "description": "The message priority level. Can be one of the following values:\n\n* An integer in the range 1-5; 1 represents the highest priority.\n* One of the following string values, which correspond to the numeric values: highest or urgent, high, normal, low, and lowest or non-urgent.", + "default": false, + "type": "String", + "required": false + }, + { + "name": "usessl", + "description": "Whether to use Secure Sockets Layer.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "proxyserver", + "description": "Host name or IP address of a proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyport", + "description": "The port number on the proxy server from which the object is requested. Default is 80. When\nused with resolveURL, the URLs of retrieved documents that specify a port number are automatically\nresolved to preserve links in the retrieved document.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "proxyuser", + "description": "When required by a proxy server, a valid username.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxypassword", + "description": "When required by a proxy server, a valid password.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "remove", + "description": "remove all attachments from filesystem after the mail is successfully sent", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "sendtime", + "description": "Set a future date time to send an email in the future via the spooler.", + "default": false, + "type": "datetime", + "required": false + }, + { + "name": "debug", + "description": "Whether to enable detailed logging to console.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/mailparam.json b/data/en/mailparam.json new file mode 100644 index 000000000..37da69af8 --- /dev/null +++ b/data/en/mailparam.json @@ -0,0 +1,73 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/mailparam.html"}}, + "name": "mailparam", + "description": "Can either attach a file or add a header to a message. It is nested within a cfmail tag. You can\nuse more than one cfmailparam tag within a cfmail tag.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "file", + "description": "Attaches the specified file to the message. This attribute is mutually exclusive with the\nname attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filename", + "description": "file name used for the file attached with the attribute \"file\", if not set the name of the file itself is used.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "Specifies the name of the header. Header names are case insensitive. This attribute is mutually\nexclusive with the file attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "value", + "description": "Indicates the value of the header.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "The MIME media type of the part.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "disposition", + "description": "How the attached file is to be handled. Can be one of the following:\n\n- attachment: presents the file as an attachment.\n- inline: displays the file contents in the message.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "contentid", + "description": "The Identifier for the attached file. This ID should be globally unique and is used to identify the file in an IMG or other tag in the mail body that references the file content.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "remove", + "description": "remove attachment from filesystem after the mail is successfully sent", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "content", + "description": "send given value as attachment", + "default": false, + "type": "any", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/mailpart.json b/data/en/mailpart.json new file mode 100644 index 000000000..8e16379a9 --- /dev/null +++ b/data/en/mailpart.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/mailpart.html"}}, + "name": "mailpart", + "description": "Specifies one part of a multipart e-mail message. Can only be used in the cfmail tag. You can use more than one cfmailpart tag within a cfmail tag", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "type", + "description": "The MIME media type of the part", + "default": false, + "type": "string", + "required": true + }, + { + "name": "wraptext", + "description": "Specifies the maximum line length, in characters of the mail text", + "default": false, + "type": "number", + "required": false + }, + { + "name": "charset", + "description": "The character encoding in which the part text is encoded", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/markdowntohtml.json b/data/en/markdowntohtml.json new file mode 100644 index 000000000..0b238099e --- /dev/null +++ b/data/en/markdowntohtml.json @@ -0,0 +1,35 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/markdowntohtml.html", + "minimum_version": "6.0" + }}, + "name": "markdowntohtml", + "description": "Transforms Markdown formatted String into HTML.", + "syntax": "markdowntohtml( string )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "string", + "description": "A Markdown formatted string or a path to a file containf a markdown formatted string to convert to HTML", + "aliases": "markdown", + "type": "string", + "required": true + }, + { + "name": "safeMode", + "description": "If set to true it does escape unsafe HTML tags", + "default": "false", + "aliases": "safe", + "type": "boolean", + "required": false + }, + { + "name": "encoding", + "description": "Charset, only used in case the argument markdown contains a file path", + "aliases": "charset", + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/maveninfo.json b/data/en/maveninfo.json new file mode 100644 index 000000000..2fcc7c2c7 --- /dev/null +++ b/data/en/maveninfo.json @@ -0,0 +1,52 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/maveninfo.html", + "minimum_version": "7.0" + }}, + "name": "maveninfo", + "description": "Retrieves information about a Maven artifact and its dependencies.\nThis function allows you to query details about a specific Maven artifact by providing its coordinates (groupId, artifactId, and optionally version). \nIt returns a query containing information about the artifact itself and all of its dependencies based on the specified scope.\nThe returned query includes columns for:\n- **groupId**: The group identifier of the artifact\n- **artifactId**: The artifact identifier\n- **version**: The version of the artifact\n- **scope**: The scope of the dependency (compile, provided, runtime, test, system)\n- **optional**: Whether the dependency is optional\n- **checksum**: Checksum information\n- **url**: URL where the artifact can be found\n- **path**: Local file path to the artifact\nThis function is useful for debugging classloading issues, understanding dependency trees, or gathering information about the libraries your application depends on.", + "syntax": "maveninfo( groupId, artifactId, version )", + "returns": "query", + "type": "function", + "params": [ + { + "name": "groupId", + "description": "The Maven group identifier that specifies the namespace for the artifact.", + "type": "string", + "required": true + }, + { + "name": "artifactId", + "description": "The Maven artifact identifier that specifies the name of the artifact.", + "type": "string", + "required": true + }, + { + "name": "version", + "description": "The specific version of the Maven artifact to query.", + "type": "string", + "required": true + }, + { + "name": "scopes", + "description": "The dependency scopes to consider when retrieving dependencies. this is an array containing all scopes you wanna include in the resulting query.\n\nValid values are:\n\n- compile\n- provided\n- runtime\n- test\n- system\n\nDefault are all scopes excluding test.", + "type": "array", + "required": false + }, + { + "name": "includeOptional", + "description": "If true, includes optional dependencies in the results. If false, excludes dependencies marked as optional from the query results.", + "default": "true", + "type": "boolean", + "required": false + }, + { + "name": "validateURL", + "description": "A Maven artifact can be provided from different repositories, not all repositories provide all artifacts. if set to false, Lucee simply picks the most likely repository. \nIf set to true, Lucee checks all possibilities, what can take a while, so only set to true, if really neded.", + "default": "false", + "aliases": "validate", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/mavenload.json b/data/en/mavenload.json new file mode 100644 index 000000000..bd5620698 --- /dev/null +++ b/data/en/mavenload.json @@ -0,0 +1,18 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/mavenload.html", + "minimum_version": "6.2" + }}, + "name": "mavenload", + "description": "Loads all JAR files from one or more Maven endpoints and makes them available for use within the Lucee server environment. \nThis function can be used to load dependencies, including transitive ones, for example at server startup.\n### Example Usage of MavenLoad Function\nThe `MavenLoad` function allows you to load JAR files from Maven repositories, including all transitive dependencies. \nThis is particularly useful during server startup to ensure that all required libraries are available.\n#### Example Input as an Array of Structs:\n```cfml\nmavenLoad([\n{\n\"groupId\": \"org.slf4j\",\n\"artifactId\": \"slf4j-api\",\n\"version\": \"1.7.32\"\n}\n]);\n```", + "syntax": "mavenload( input )", + "returns": "array", + "type": "function", + "params": [{ + "name": "input", + "description": "A struct or an array of structs specifying the Maven coordinates, including groupId, artifactId, and version.", + "aliases": "data,endpoint", + "type": "any", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/module.json b/data/en/module.json new file mode 100644 index 000000000..5c9e98d9a --- /dev/null +++ b/data/en/module.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/module.html"}}, + "name": "module", + "description": "Invokes a custom tag for use in cfml templates. The cfmodule tag can help deal with\ncustom tag name conflicts. Use the template attribute to name a template that contains the custom\ntag definition, including its path..", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/object.json b/data/en/object.json new file mode 100644 index 000000000..b59acfd50 --- /dev/null +++ b/data/en/object.json @@ -0,0 +1,122 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/object.html"}}, + "name": "object", + "description": "Lets you call methods in COM, CORBA, and JAVA objects.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "name for the instantiated component.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "component", + "description": "Name of component to instantiate.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "The object type. You can omit this attribute or specify component. Lucee automatically sets the type to component.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "action", + "description": "- create: instantiates a COM object (typically, a DLL) before invoking methods or properties.\n- connect: connects to a COM object (typically, an EXE) running on server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "class", + "description": "Component ProgID for the object to invoke. When using Java stubs to connect to the COM object, the class must be the ProgID of the COM object.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "context", + "description": "- inproc\n - local\n - remote\n\nIn Windows, if not specified, uses Registry setting.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "delimiters", + "description": "if specified a classpath, use as delimiter for the entries, default is comma.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "server", + "description": "Server name, using Universal Naming Convention (UNC) or Domain Name Serve (DNS) convention, in one of these forms:\n\n* \\\\lanserver\n* lanserver\n* \n* www.servername.com\n* 127.0.0.1", + "default": false, + "type": "string", + "required": false + }, + { + "name": "locale", + "description": "Sets arguments for a call to init_orb. Use this attribute only for VisiBroker ORBs. It is available on C++, Version 3.2. The value must be in the form:\nlocale = \" -ORBagentAddr 199.99.129.33 -ORBagentPort 19000\"\n\nEach type-value pair must start with a hyphen.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "webservice", + "description": "The absolute URL of the web service.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "username", + "description": "The user name to use to access the web service. If the webservice attribute specifies a web service configured name in the Lucee Administrator, overrides any user name specified in the Administrator entry.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "The password to use to access the web service. If the webservice attribute specifies a web service name configured in the Lucee Administrator, overrides any password specified in the Administrator entry.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyserver", + "description": "The proxy server required to access the web service URL.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyport", + "description": "The port to use on the proxy server.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "proxyuser", + "description": "The user ID to send to the proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxypassword", + "description": "The user's password on the proxy server.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/objectcache.json b/data/en/objectcache.json new file mode 100644 index 000000000..c47ec1adb --- /dev/null +++ b/data/en/objectcache.json @@ -0,0 +1,45 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/objectcache.html"}}, + "name": "objectcache", + "description": "Flushes an object cache or returns the current size.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "- clear\n- size\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "type", + "description": "cache type to manipulate\n\n- function\n- include\n- object\n- query\n- resource\n- template\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filter", + "description": "filter for the elements to delete", + "default": false, + "type": "object", + "required": false + }, + { + "name": "filterignorecase", + "description": "filter for the elements to delete", + "default": false, + "type": "string", + "required": false + }, + { + "name": "result", + "description": "name for variables for action size", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/output.json b/data/en/output.json new file mode 100644 index 000000000..ea85b0901 --- /dev/null +++ b/data/en/output.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/output.html"}}, + "name": "output", + "description": "Displays the results of a database query or other operation. To nest cfoutput tags, see the \"Usage\" section.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "query", + "description": "The name of the cfquery from which to draw data for the output section or the query itself.", + "default": false, + "type": "object", + "required": false + }, + { + "name": "group", + "description": "Specifies the query column to use when you group sets of records together. Use this attribute\nif you have retrieved a record set ordered on a certain query column. For example, if a record set is\nordered according to \"CustomerID\" in the cfquery tag, you can group the output on \"CustomerID.\" The\ngroup attribute, which is case sensitive, eliminates adjacent duplicates when the data is sorted by\nthe specified field. See the groupCaseSensitive attribute for information about specifying a case\ninsensitive grouping.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "groupcasesensitive", + "description": "Boolean indicating whether to group by case. The default value is YES; case is considered while\ngrouping. If the query attribute specifies a query object that was generated by a case-insensitive\nSQL query, set the groupCaseSensitive attribute to NO to keep the recordset intact.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "startrow", + "description": "Specifies the row from which to start output.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "maxrows", + "description": "Specifies the maximum number of rows to display in the output section. You cannot use this attribute together with the attribute endRow.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "endrow", + "description": "Last row of query that is included. You cannot use this attribute together with the attribute maxRows.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "encodefor", + "description": "encode for what, valid values are:\n\n- **css:** for output inside Cascading Style Sheets (CSS)\n- **dn:** for output in LDAP Distinguished Names\n- **html:** for output inside HTML\n- **html_attr:** for output inside HTML Attributes\n- **javascript:** for output inside JavaScript\n- **ldap:** for output in LDAP queries\n- **url:** for output in URL\n- **vbscript:** for output inside vbscript\n- **xml:** for output inside XML\n- **xml_attr:** for output inside XML Attributes\n- **xpath:** for output in XPath", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/pageencoding.json b/data/en/pageencoding.json new file mode 100644 index 000000000..843335aad --- /dev/null +++ b/data/en/pageencoding.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/pageencoding.html"}}, + "name": "pageencoding", + "description": "Specifies the character encoding used for the current template file. This tag is processed at compile time and must be placed at the root level of your template. It serves the same purpose as the pageEncoding attribute of cfprocessingdirective but in a dedicated tag format.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "charset", + "description": "Specifies the character encoding for the current template file. This must be a string literal corresponding to a valid character encoding (not a dynamic expression). \n\nCommon encodings include:\n\n -UTF-8 (recommended for most applications) \n -ISO-8859-1 (Latin-1)\n -Windows-1252 (Windows Western European). \nExample: charset=\"UTF-8\"", + "default": false, + "type": "string", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/param.json b/data/en/param.json new file mode 100644 index 000000000..55d2254b8 --- /dev/null +++ b/data/en/param.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/param.html"}}, + "name": "param", + "description": "Tests for a parameter's existence, tests its data type, and provides a default value if one\nis not assigned.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "The name of the parameter to test, such as Client.Email or Cookie.BackgroundColor. If\nyou omit the DEFAULT attribute, an error occurs if the specified parameter does not exist", + "default": false, + "type": "string", + "required": true + }, + { + "name": "type", + "description": "The type of parameter that is required. The default is 'any' and valid values are:\n\n- any: any type of value\n- array: an array of values\n- binary: a binary value\n- boolean: a Boolean value\n- creditcard: a 13-16 digit number conforming to the mod10 algorithm\n- date or time: a date-time value\n- email: a valid e-mail address\n- eurodate: a date-time value. Any date part must be in the format dd/mm/yy. The format can use /, -, or . characters as delimiters\n- float or numeric: a numeric value\n- guid: a Universally Unique Identifier of the form \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\" where X is a hexadecimal number\n- integer: an integer\n- query: a query object\n- range: a numeric range, specified by the min and max attributes\n- regex or regular_expression: matches input against pattern attribute\n- ssn or social_security_number: a U.S. social security number\n- string: a string value or single character\n- struct: a structure\n- telephone: a standard U.S. telephone number\n- url: an http, https, ftp, file, mailto, or news URL\n- uuid: a ColdFusion Universally Unique Identifier, formatted XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXX, where X is a hexadecimal number. See CreateUUID\n- usdate: a U.S. date of the format mm/dd/yy, with 1-2 digit days and months, 1-4 digit years\n- variableName: a string formatted according to ColdFusion variable naming conventions\n- xml: XML objects and XML strings\n- zipcode: U.S., 5- or 9-digit format ZIP codes", + "default": false, + "type": "string", + "required": false + }, + { + "name": "default", + "description": "Default value to set the parameter to if it does not exist.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "min", + "description": "define the smallest size of a numeric value, used for type range", + "default": false, + "type": "number", + "required": false + }, + { + "name": "max", + "description": "define the biggest size of a numeric value, used for type range", + "default": false, + "type": "number", + "required": false + }, + { + "name": "pattern", + "description": "define a regular expression pattern, to check value against", + "default": false, + "type": "string", + "required": false + }, + { + "name": "maxlength", + "description": "define the maxlength of a value for this types: email, url and string", + "default": false, + "type": "int", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/pdf.json b/data/en/pdf.json new file mode 100644 index 000000000..da74f692b --- /dev/null +++ b/data/en/pdf.json @@ -0,0 +1,325 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/pdf.html"}}, + "name": "pdf", + "description": "Manipulates existing PDF documents.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "- addHeader\n- addFooter\n- addWatermark\n- deletePages\n- extractText\n- getInfo\n- merge\n- open\n- removePassword\n- protect\n- read\n- removeWatermark\n- setInfo\n- thumbnail \n- write\n\n**Note:** action \"thumbnail\" was implemented from PDF Extension version - 1.1.0.8", + "default": false, + "type": "string", + "required": false + }, + { + "name": "ascending", + "description": "Order in which the PDF files are sorted", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "type", + "description": "used for action \"extractText\", defines the format type of the extraction, valid values are: string,xml", + "default": false, + "type": "string", + "required": false + }, + { + "name": "copyfrom", + "description": "Pathname of the PDF document from which to use the first page as a watermark", + "default": false, + "type": "any", + "required": false + }, + { + "name": "ddxfile", + "description": "Pathname of the DDX file, or a string with DDX instructions", + "default": false, + "type": "string", + "required": false + }, + { + "name": "destination", + "description": "Pathname of the modified PDF document. If the destination file exists, you must set the overwrite attribute to yes. If the destination file does not exist, CFML creates the file, if the parent directory exists.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "directory", + "description": "Directory of the PDF documents to merge. You must specify either the directory attribute or the source attribute. If you specify the directory attribute, CFML orders the documents by filename in descending order, by default. To change the order of the files, use the order attribute.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "encrypt", + "description": "Encryption type for the PDF output file", + "default": false, + "type": "string", + "required": false + }, + { + "name": "flatten", + "description": "Applies to forms created in Acrobat only (not forms created in LiveCycle); specifies whether interactivity is turned off", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "foreground", + "description": "Placement of the watermark on the page", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "format", + "description": "File type of thumbnail image output", + "default": false, + "type": "string", + "required": false + }, + { + "name": "image", + "description": "Image used as a watermark. You can specify a pathname, a variable that contains an image file, or an image variable", + "default": false, + "type": "any", + "required": false + }, + { + "name": "imageprefix", + "description": "prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "filter", + "description": "file filter, used with attribute directory", + "default": false, + "type": "string", + "required": false + }, + { + "name": "info", + "description": "Structure variable for relevant information", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "inputfiles", + "description": "Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname.", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "isbase64", + "description": "Valid only when the image attribute is specified. Specifies whether the image used as a watermark is in Base64 format", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "keepbookmark", + "description": "Specifies whether bookmarks from the source PDF documents are retained in the merged document", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "name", + "description": "PDF document variable name", + "default": false, + "type": "string", + "required": false + }, + { + "name": "newownerpassword", + "description": "Password used to set permissions on a PDF document", + "default": false, + "type": "string", + "required": false + }, + { + "name": "newuserpassword", + "description": "Password used to open PDF document", + "default": false, + "type": "string", + "required": false + }, + { + "name": "opacity", + "description": "Opacity of the watermark. Valid values are integers in the range 0 (transparent) through 10 (opaque).", + "default": false, + "type": "number", + "required": false + }, + { + "name": "order", + "description": "Order in which the PDF documents in the directory are merged", + "default": false, + "type": "string", + "required": false + }, + { + "name": "outputfiles", + "description": "Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value.", + "default": false, + "type": "struct", + "required": false + }, + { + "name": "overwrite", + "description": "Specifies whether PDF output overwrites the destination file", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "pages", + "description": "Page or pages in the source PDF document on which to perform the action. You can specify multiple pages and page ranges as follows: \"1,6-9,56-89,100, 110-120\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "Owner or user password of the source PDF document, if the document is password-protected.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "permissions", + "description": "type of permissions on the PDF document", + "default": false, + "type": "string", + "required": false + }, + { + "name": "position", + "description": "Position on the page where the watermark is placed. The position represents the top-left corner of the watermark. Specify the x and y coordinates; for example \"50,30\".", + "default": false, + "type": "string", + "required": false + }, + { + "name": "resolution", + "description": "Image quality used to generate thumbnail images", + "default": false, + "type": "string", + "required": false + }, + { + "name": "rotation", + "description": "Degree of rotation of the watermark image on the page.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "saveoption", + "description": "Save options for the PDF output", + "default": false, + "type": "string", + "required": false + }, + { + "name": "scale", + "description": "Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "showonprint", + "description": "Specify whether to print the watermark with the PDF document", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "source", + "description": "PDF document used as the source.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "stoponerror", + "description": "Valid only if the directory attribute is specified. If the specified directory contains files other then readable PDF files, Lucee either stops merge process or continues.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "transparent", + "description": "(format=\"png\" only) Specifies whether the image background is transparent or opaque", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "version", + "description": "Version of the PDF used to write the document", + "default": false, + "type": "number", + "required": false + }, + { + "name": "text", + "description": "text for header or footer, you can add the following place holders within the text:\n\n- _PAGELABEL: add current page label\n- _LASTPAGELABEL: add last page label\n- _PAGENUMBER: add current page number\n- _LASTPAGENUMBER: add last page number", + "default": false, + "type": "string", + "required": false + }, + { + "name": "numberformat", + "description": "Specify the numbering format for PDF pages in the header/footer.\npossible values are:\n\n- LOWERCASEROMAN\n- UPPERCASEROMAN\n- NUMERIC", + "default": false, + "type": "string", + "required": false + }, + { + "name": "align", + "description": "Aligns the header and footer in PDF:\n\n- left\n- right\n- center", + "default": false, + "type": "string", + "required": false + }, + { + "name": "leftmargin", + "description": "left margin of the text in header/footer", + "default": false, + "type": "numeric", + "required": false + }, + { + "name": "rightmargin", + "description": "right margin of the text in header/footer", + "default": false, + "type": "numeric", + "required": false + }, + { + "name": "topmargin", + "description": "top margin of the text in header", + "default": false, + "type": "numeric", + "required": false + }, + { + "name": "bottommargin", + "description": "bottom margin of the text in footer", + "default": false, + "type": "numeric", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/pdfparam.json b/data/en/pdfparam.json new file mode 100644 index 000000000..ae9a7e464 --- /dev/null +++ b/data/en/pdfparam.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/pdfparam.html"}}, + "name": "pdfparam", + "description": "Provides additional information for the cfpdf tag. The cfpdfparam tag applies only to the merge action of the cfpdf tag and is always a child tag of the cfpdf tag.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "pages", + "description": "Page number or Pages of the PDF source file to merge.\n\nYou can specify a range of pages, for example\n\n- \"1\"\n- \"1-5\"\n- a comma-separated list of pages, for example, \"1-5,9-10,18\"\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "User or owner password, if the source PDF file is password-protected.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "source", + "description": "Source PDF file to merge.\n\nYou can specify\n\n- a PDF variable\n- a cfdocument variable\n- a url to a PDF document\n- or the pathname to a file\n", + "default": false, + "type": "any", + "required": true + } + ] +} \ No newline at end of file diff --git a/data/en/pop.json b/data/en/pop.json new file mode 100644 index 000000000..970de7cc0 --- /dev/null +++ b/data/en/pop.json @@ -0,0 +1,129 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/pop.html"}}, + "name": "pop", + "description": "Retrieves and deletes e-mail messages from a POP mail server.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "connection", + "description": "label for a connection.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "server", + "description": "Host name biff.upperlip.com or IP address 192.1.2.225 of the POP server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "uid", + "description": "UID or a comma-delimited list of UIDs to get or delete.\nInvalid UIDs are ignored.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "port", + "description": "Defaults to the standard POP port, 110.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "username", + "description": "If no user name is specified, the POP connection is anonymous.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "Password that corresponds to user name.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "secure", + "description": "enables SSL for pop requests", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "action", + "description": "Specifies the mail action.\n\n- getHeaderOnly: returns message header information only\n- getAll: returns message header information, message text, and attachments if attachmentPath is specified\n- delete: deletes messages on POP server\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "Name for the index query.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "messagenumber", + "description": "Can be a comma-separated list of the message ids", + "default": false, + "type": "string", + "required": false + }, + { + "name": "attachmentpath", + "description": "Allows attachments to be written to the specified directory when action = \"getAll\". If an\ninvalid attachmentPath is specified, no attachment files are written to the server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "debug", + "description": "this attribute is deprecated and ignored, log control happens via the logging framework directly.\n", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "maxrows", + "description": "Sets the number of messages returned, starting with the number in the startRow attribute.\nThis attribute is ignored if messageNumber is specified.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "startrow", + "description": "Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if\nmessageNumber is specified.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "generateuniquefilenames", + "description": "Boolean indicating whether to generate unique filenames for the files attached to an e-mail\nmessage to avoid naming conflicts when the files are saved. Default is NO.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "delimiter", + "description": "Character that separates uid list, The default value is comma(,).", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/processingdirective.json b/data/en/processingdirective.json new file mode 100644 index 000000000..09135cc94 --- /dev/null +++ b/data/en/processingdirective.json @@ -0,0 +1,38 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/processingdirective.html"}}, + "name": "processingdirective", + "description": "Sets compiler directives that affect the entire template. Unlike most CFML tags, cfprocessingdirective is processed at compile time and must be placed at the root level of your template.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "suppresswhitespace", + "description": "When set to true, removes unnecessary whitespace from the generated HTML output, reducing the file size and potentially improving page load times.\n\nThis includes: \n\n -spaces\n -tabs\n -line breaks between HTML elements. \nExample: suppressWhiteSpace=\"true\"", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "executionlog", + "description": "Controls whether execution time logging is enabled for this template. When set to true, Lucee will log performance metrics for this template, which can be valuable for debugging and optimization. \n\nExample: executionLog=\"true\"", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "pageencoding", + "description": "Specifies the character encoding used for the current template file. This must be a string literal corresponding to a valid character encoding (not a dynamic expression).\n\nCommon values: \n\n -UTF-8 (Unicode, recommended for most applications)\n -ISO-8859-1 (Latin-1)\n -Windows-1252 (Windows Western European). \nExample: pageEncoding=\"UTF-8\"", + "default": false, + "type": "string", + "required": false + }, + { + "name": "preservecase", + "description": "Controls how variable keys defined using dot notation are handled:\n\t\n\tWhen preserveCase=\"false\" (default): All struct keys defined with dot notation are converted to uppercase.\n\tExample: sct.dotNotation becomes key \"DOTNOTATION\" while sct[\"bracketNotation\"] remains \"bracketNotation\"\n\t\n\tWhen preserveCase=\"true\": Struct keys defined with dot notation maintain their original case.\n\tExample: sct.dotNotation remains key \"dotNotation\" and sct[\"bracketNotation\"] remains \"bracketNotation\"\n\t\n\tThis setting affects all dot notation usage throughout the template.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/procparam.json b/data/en/procparam.json new file mode 100644 index 000000000..a9d659050 --- /dev/null +++ b/data/en/procparam.json @@ -0,0 +1,73 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/procparam.html"}}, + "name": "procparam", + "description": "Specifies parameter information, including type, name, value, and length. The cfprocparam tag\nis nested within a cfstoredproc tag.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "type", + "description": "Indicates whether the passed variable is an input, output or input/output variable. Default is IN.\n\tThe value IN passes the parameter by value. Values OUT and INOUT pass parameters as bound variables.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "variable", + "description": "The variable name that you use to reference the value that the output parameter\n\trepresents after the call is made to the stored procedure.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "dbvarname", + "description": "This attribute has been deprecated and is non-functional.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "value", + "description": "Corresponds to the actual value that Lucee passes to the stored procedure.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "sqltype", + "description": "The SQL type that the parameter (any type) will be bound to.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cfsqltype", + "description": "This attribute has been deprecated, use instead the attribute \"sqltype\" that has exact the same functionality.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "maxlength", + "description": "Maximum length of the parameter.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "scale", + "description": "Number of decimal places of the parameter.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "null", + "description": "Indicates whether the parameter is passed as a null. If you specify Yes, the tag ignores\n\tthe value attribute.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/procresult.json b/data/en/procresult.json new file mode 100644 index 000000000..4acb93b4d --- /dev/null +++ b/data/en/procresult.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/procresult.html"}}, + "name": "procresult", + "description": "Specifies a result set name that other tags, such as cfoutput and cftable, use to access\nthe result set. It also lets you optionally identify which of the stored procedure's result sets to\nreturn. The cfprocresult tag is nested within a cfstoredproc tag.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "Name for the query result set.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "resultset", + "description": "Identifies the desired result set if the stored procedure returns multiple result sets.\n\nDefault is 1.", + "default": false, + "type": "number", + "required": false + }, + { + "name": "maxrows", + "description": "Specifies the maximum number of rows returned in the result set. The default is to return\nall rows in the result set.", + "default": false, + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/property.json b/data/en/property.json new file mode 100644 index 000000000..61116c12c --- /dev/null +++ b/data/en/property.json @@ -0,0 +1,73 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/property.html"}}, + "name": "property", + "description": "Defines properties within components that can be used for web services, ORM mapping, and accessor method generation. Properties are exposed as component metadata and follow component inheritance rules.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "name", + "description": "A string; a property name. Must be a static value.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "type", + "description": "A string; a property type name; data type.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "required", + "description": "Whether the parameter is required", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "default", + "description": "This sets the default value on the property when the object is created.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "displayname", + "description": "A value to be displayed when using introspection to show\ninformation about the CFC. The value appears in parentheses\nfollowing the property name.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "hint", + "description": "Text to be displayed when using introspection to show\ninformation about the CFC. This attribute can be useful\nfor describing the purpose of the parameter.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "access", + "description": "The client security context from which the method can be invoked", + "default": false, + "type": "string", + "required": false + }, + { + "name": "getter", + "description": "Specifies whether to generate getter methods or not", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "setter", + "description": "Specifies whether to generate setter methods or not", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/queryclose.json b/data/en/queryclose.json new file mode 100644 index 000000000..13b43cbe2 --- /dev/null +++ b/data/en/queryclose.json @@ -0,0 +1,17 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/queryclose.html", + "minimum_version": "5.3" + }}, + "name": "queryclose", + "description": "When using lazy=\"true\", it is important to close the resultSet during a request or it will continue to use heap memory.", + "syntax": "queryclose( query )", + "returns": "boolean", + "type": "function", + "params": [{ + "name": "query", + "description": "Query object to close.", + "type": "query", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/querygetcellbyindex.json b/data/en/querygetcellbyindex.json new file mode 100644 index 000000000..798544844 --- /dev/null +++ b/data/en/querygetcellbyindex.json @@ -0,0 +1,38 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/querygetcellbyindex.html", + "minimum_version": "5.3" + }}, + "name": "querygetcellbyindex", + "description": "return the value of a specific query cell", + "syntax": "querygetcellbyindex( query, column_name, index )", + "returns": "any", + "type": "function", + "params": [ + { + "name": "query", + "description": "query to get cell value from", + "type": "query", + "required": true + }, + { + "name": "column_name", + "description": "name of the column", + "type": "string", + "required": true + }, + { + "name": "index", + "description": "Name of the index.", + "type": "string", + "required": true + }, + { + "name": "defaultValue", + "description": "In case no matching index was found, this value is returned by the function, in case it is not set, the function will throw an exception.", + "minimum_version": "any", + "type": "any", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/queryisempty.json b/data/en/queryisempty.json new file mode 100644 index 000000000..c7ab9110f --- /dev/null +++ b/data/en/queryisempty.json @@ -0,0 +1,17 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/queryisempty.html", + "minimum_version": "6.0" + }}, + "name": "queryisempty", + "description": "returns query empty or not", + "syntax": "queryisempty( query )", + "returns": "boolean", + "type": "function", + "params": [{ + "name": "query", + "description": "Query object to check.", + "type": "query", + "required": true + }] +} \ No newline at end of file diff --git a/data/en/queryparam.json b/data/en/queryparam.json new file mode 100644 index 000000000..7025e2cf6 --- /dev/null +++ b/data/en/queryparam.json @@ -0,0 +1,77 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/queryparam.html", + "notes": "Prior to Lucee 6, an empty value would be auto cast to null, since Lucee 6 only strings are handled this way [LDEV-4410](https://luceeserver.atlassian.net/browse/LDEV-4410)\n\nIn Lucee 6, this is no longer the default behavior and throws an exception, which matches ACF.\n\nYou can re-enable the old behavior by setting this environment variable or system property to `true`.\n\n**Environment Variable:** `LUCEE_QUERY_ALLOWEMPTYASNULL=TRUE` \n**System Property:** `-Dlucee.query.allowemptyasnull=\"true\"`\n" + }}, + "name": "queryparam", + "description": "Checks the data type of a query parameter.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "value", + "description": "Specifies the actual value that Lucee passes to the database.\n \t\n- For standard parameters: The single value used in the query\n- For list parameters: Can be an array, list string, or other collection type\n- For null values: Set the `null` attribute to true and this attribute is ignored\n \t\n \tThe value will be automatically escaped to prevent SQL injection.\n", + "default": false, + "type": "any", + "required": false + }, + { + "name": "sqltype", + "description": "The SQL data type that the parameter will be bound to.\n\t\nCommon types include:\n\n- `varchar`: For strings (default)\n- `integer`, `bigint`, `smallint`, `tinyint`: For various sized integers\n- `double`, `decimal`, `money`: For floating point/decimal values\n- `bit`, `boolean`: For boolean values\n- `date`, `time`, `timestamp`: For date/time values\n- `binary`, `blob`: For binary data\n\nA list of SQL types can be found on the [SQL Type page](/guides/cookbooks/Sql-Types.html). All can be used with or without the `CF_SQL_` prefix.\n\tUsing the correct type improves security, enables proper type checking, and optimizes query execution. \n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "cfsqltype", + "description": "This attribute has been deprecated, use the `sqlType` attribute instead which provides identical functionality.\n \t\n \tMaintained for backward compatibility with older code that used the CFML-specific naming convention.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "maxlength", + "description": "Maximum allowed length of the parameter value (validation check).\n \t\n- For string values: The maximum number of characters allowed\n- For binary values: The maximum number of bytes allowed\n- If the value exceeds this length, Lucee will throw an exception\n- If not specified, defaults to the actual length of the provided value\n- If the attribute `charset` is defined, string length comparison will be byte-based for that encoding", + "default": false, + "type": "number", + "required": false + }, + { + "name": "charset", + "description": "Specifies the character encoding for string validation.\n \t\nThis attribute serves two purposes:\n\n1. It validates that the given value is compatible with the specified charset\n2. It determines how byte length is calculated for `maxLength` validation\n \t\nCommon values include `UTF-8`, `ISO-8859-1`, or other valid Java charset names.This attribute is used for 2 things:\n\n- it checks if the given value is compatible with that charset\n- to check the binary length of the value (see attribute maxlength).", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "scale", + "description": "Number of decimal places to allow for numeric parameters.\n \t\n- Only applies to decimal data types (decimal, numeric, money, etc.)\n- Values with more decimal places than specified will be rounded\n- Particularly important for financial calculations to control precision\n- Default value is zero if not specified", + "default": false, + "type": "number", + "required": false + }, + { + "name": "null", + "description": "Indicates whether the parameter should be treated as NULL.\n \t\n- `true`: The parameter is passed as NULL to the database (ignores the `value` attribute)\n- `false`: The parameter uses the value provided in the `value` attribute\n- Default is `false`\n \t\nSQL comparison with NULL requires special syntax in most databases (using `IS NULL` rather than `= NULL`).", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "list", + "description": "Controls how the parameter value is handled:\n \t\n- `true`: The parameter value is treated as a list of values (typically used with SQL's `IN` operator)\n- `false`: The parameter is handled as a simple value\n- Not set: Lucee automatically detects if the value is an array and treats it as a list if it is (but not for byte arrays)\n \t\nWhen working with lists/arrays:\n\n- **Empty Arrays**: When an empty array is provided with `list=true` (or auto-detected as a list), Lucee will handle this correctly by effectively omitting the parameter from the query\n- **Usage with IN**: Typically used with SQL's `IN` operator\n- **Array Elements**: Each element in the array will be properly typed according to the specified `sqlType`", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "separator", + "description": "Specifies the character that separates values in string lists.\n \t\n- Only used when `list=\"true\"` and the value is a string (not an array)\n- Default separator is a comma (`,`)\n- Common alternatives include semicolon (`;`), pipe (`|`), or tab\n- Example: For a string like \"red;green;blue\" with `list=\"true\" separator=\";\"`, the values would be treated as three separate items\n \t\nNote: For best results with complex separators or values that might contain the separator character, consider using an array instead of a delimited string.", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/queryrenamecolumn.json b/data/en/queryrenamecolumn.json new file mode 100644 index 000000000..e7a532bfc --- /dev/null +++ b/data/en/queryrenamecolumn.json @@ -0,0 +1,32 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/queryrenamecolumn.html", + "minimum_version": "6.0" + }}, + "name": "queryrenamecolumn", + "description": "Rename a column", + "syntax": "queryrenamecolumn( query, column, newColumnName )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "query", + "description": "Name of a query object.", + "type": "query", + "required": true + }, + { + "name": "column", + "description": "Name of the column to rename.", + "aliases": "columnName", + "type": "string", + "required": true + }, + { + "name": "newColumnName", + "description": "New name of the column.", + "type": "string", + "required": true + } + ] +} \ No newline at end of file diff --git a/data/en/queryrowbyindex.json b/data/en/queryrowbyindex.json new file mode 100644 index 000000000..21f892e59 --- /dev/null +++ b/data/en/queryrowbyindex.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/queryrowbyindex.html", + "minimum_version": "5.3" + }}, + "name": "queryrowbyindex", + "description": "", + "syntax": "queryrowbyindex( query, index )", + "returns": "numeric", + "type": "function", + "params": [ + { + "name": "query", + "description": "query object do get data from", + "type": "query", + "required": true + }, + { + "name": "index", + "description": "Name of the index.", + "type": "string", + "required": true + }, + { + "name": "defaultValue", + "description": "In case no matching index was found, this value is returned by the function, in case it is not set, the function will throw an exception.", + "type": "numeric", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/queryrowdatabyindex.json b/data/en/queryrowdatabyindex.json new file mode 100644 index 000000000..f7aa41a4c --- /dev/null +++ b/data/en/queryrowdatabyindex.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/queryrowdatabyindex.html", + "minimum_version": "5.3" + }}, + "name": "queryrowdatabyindex", + "description": "", + "syntax": "queryrowdatabyindex( query, index )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "query", + "description": "query object do get data from", + "type": "query", + "required": true + }, + { + "name": "index", + "description": "Name of the index", + "type": "string", + "required": true + }, + { + "name": "defaultValue", + "description": "In case no matching index was found, this value is returned by the function, in case it is not set, the function will throw an exception.", + "type": "struct", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/querytostruct.json b/data/en/querytostruct.json new file mode 100644 index 000000000..6762c645e --- /dev/null +++ b/data/en/querytostruct.json @@ -0,0 +1,41 @@ +{ + "engines": {"lucee": { + "docs": "https://docs.lucee.org/reference/functions/querytostruct.html", + "minimum_version": "6.0" + }}, + "name": "querytostruct", + "description": "Copy the query columns data to struct by using the columnKey argument", + "syntax": "querytostruct( query, columnKey )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "query", + "description": "A query to copy to a struct", + "type": "query", + "required": true + }, + { + "name": "columnKey", + "description": "Column name that values are used for struct key", + "aliases": "column,columnName", + "type": "string", + "required": true + }, + { + "name": "structType", + "description": "default:ordered, Struct type to created", + "default": "ordered", + "aliases": "type", + "type": "string", + "required": false + }, + { + "name": "valueRowNumber", + "description": "default: false, the boolean value that indicates the struct values return as column data or row number", + "aliases": "valueAsRowNumber", + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/registry.json b/data/en/registry.json new file mode 100644 index 000000000..c10916d7a --- /dev/null +++ b/data/en/registry.json @@ -0,0 +1,66 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/registry.html"}}, + "name": "registry", + "description": "Reads, writes, and deletes keys and values in the system registry. The cfregistry tag is supported\non all platforms, including Linux, Solaris, and HP-UX.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "action to the registry", + "default": false, + "type": "string", + "required": true + }, + { + "name": "branch", + "description": "Name of a registry branch.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "type", + "description": "string: return string values\ndWord: return DWord values\nkey: return keys\nany: return keys and values", + "default": false, + "type": "string", + "required": false + }, + { + "name": "name", + "description": "Name of record set to contain returned keys and values.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "sort", + "description": "Sorts query column data (case-insensitive). Sorts on Entry, Type, and Value columns as text. Specify a combination of columns from query output, in a comma-delimited list. For example:\nsort = \"value desc, entry asc\"\n\nasc: ascending (a to z) sort order\ndesc: descending (z to a) sort order", + "default": false, + "type": "string", + "required": false + }, + { + "name": "entry", + "description": "Registry value to access.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "variable", + "description": "Variable into which to put value.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "value", + "description": "Value data to set. If you omit this attribute, cfregistry creates default value, as follows:\n\nstring: creates an empty string: \"\"\ndWord: creates a value of 0 (zero)", + "default": false, + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/rethrow.json b/data/en/rethrow.json new file mode 100644 index 000000000..5a45af268 --- /dev/null +++ b/data/en/rethrow.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/rethrow.html"}}, + "name": "rethrow", + "description": "Rethrows the currently active exception. Preserves the exception's cfcatch.type and cfcatch.\nagContext information.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/retry.json b/data/en/retry.json new file mode 100644 index 000000000..65c3db179 --- /dev/null +++ b/data/en/retry.json @@ -0,0 +1,9 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/retry.html"}}, + "name": "retry", + "description": "used to jump from a catch block, back to the beginning of the try block.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [] +} \ No newline at end of file diff --git a/data/en/return.json b/data/en/return.json new file mode 100644 index 000000000..76d3421ae --- /dev/null +++ b/data/en/return.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/return.html"}}, + "name": "return", + "description": "Returns result values from a component method. Contains an expression returned as result of the function.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [{ + "name": "expr", + "description": "An expression; the result of the function from which this tag is called.", + "default": false, + "type": "any", + "required": false + }] +} \ No newline at end of file diff --git a/data/en/s3addacl.json b/data/en/s3addacl.json new file mode 100644 index 000000000..0c3fe0be7 --- /dev/null +++ b/data/en/s3addacl.json @@ -0,0 +1,60 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3addacl.html"}}, + "name": "s3addacl", + "description": "Adds ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object definition (S3AddACL(bucket:\"mybucket\",object:\"myobject.txt\",acl:data) ) or as a virtual filesystem path (S3AddACL(path:\"s3://mybucket/myobject.txt\",acl:data) ).", + "syntax": "s3addacl( bucketNameOrPath, aclObject )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "bucketNameOrPath", + "description": "This can be the bucketname or a virtual filesystem path for a file/directory (example \"s3://mybucket/myobject.txt\").", + "aliases": "bucket,bucketName,path", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument.", + "default": "", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "aclObject", + "description": "an array of struct where each struct represents an ACL grant", + "aliases": "acl", + "type": "object", + "required": true + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3clearbucket.json b/data/en/s3clearbucket.json new file mode 100644 index 000000000..2fcce47f4 --- /dev/null +++ b/data/en/s3clearbucket.json @@ -0,0 +1,52 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3clearbucket.html"}}, + "name": "s3clearbucket", + "description": "Removes all objects from a bucket, unless maxage is set, in that case only objects that are older than maxage are removed.", + "syntax": "s3clearbucket( bucketName )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket to list objects from.", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "maxage", + "description": "Max age of the object we keep, if not set all objects are removed.", + "aliases": "age", + "type": "timespan", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].\n", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].\n", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3copy.json b/data/en/s3copy.json new file mode 100644 index 000000000..9874f7bba --- /dev/null +++ b/data/en/s3copy.json @@ -0,0 +1,80 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3copy.html"}}, + "name": "s3copy", + "description": "Copies an object in S3 from one bucket to an other.", + "syntax": "s3copy( srcBucketName, srcObjectName, trgBucketName )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "srcBucketName", + "description": "Name of the source bucket of your object to copy", + "aliases": "srcBucket,sourceBucketName,sourceBucket", + "type": "string", + "required": true + }, + { + "name": "srcObjectName", + "description": "Name of the source object (path) within the bucket of your object to copy", + "aliases": "sourceObjectName,srcObject,sourceObject", + "type": "string", + "required": true + }, + { + "name": "trgBucketName", + "description": "Name of the target bucket of your object to copy", + "aliases": "trgBucket,targetBucketName,targetBucket", + "type": "string", + "required": true + }, + { + "name": "trgObjectName", + "description": "Name of the target object (path)for the target bucket. If not defined the source obbject name is used.", + "aliases": "targetObjectName,trgObject,targetObject", + "type": "string", + "required": false + }, + { + "name": "acl", + "description": "an array of struct where each struct represents an ACL grant", + "aliases": "aclObject", + "type": "object", + "required": false + }, + { + "name": "location", + "description": "location of the S3 storage.", + "aliases": "region", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3createbucket.json b/data/en/s3createbucket.json new file mode 100644 index 000000000..74e1d6b2f --- /dev/null +++ b/data/en/s3createbucket.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3createbucket.html"}}, + "name": "s3createbucket", + "description": "Creates a bucket on S3.", + "syntax": "s3createbucket( bucketName )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket to create", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "acl", + "description": "an array of struct where each struct represents an ACL grant", + "aliases": "aclObject", + "type": "object", + "required": false + }, + { + "name": "location", + "description": "location of the S3 storage.", + "aliases": "region", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3delete.json b/data/en/s3delete.json new file mode 100644 index 000000000..a4ae83efc --- /dev/null +++ b/data/en/s3delete.json @@ -0,0 +1,58 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3delete.html"}}, + "name": "s3delete", + "description": "deletes a bucket or an object within a bucket.", + "syntax": "s3delete( bucketName )", + "returns": "query", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket to delete.", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object to delete, if not defined the bucket itself is deleted.", + "aliases": "object", + "type": "string", + "required": false + }, + { + "name": "force", + "description": "Also delete bucket if it has content.", + "type": "boolean", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3deletebucket.json b/data/en/s3deletebucket.json new file mode 100644 index 000000000..c4edf39b8 --- /dev/null +++ b/data/en/s3deletebucket.json @@ -0,0 +1,51 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3deletebucket.html"}}, + "name": "s3deletebucket", + "description": "deletes a bucket, this function is deprecated, use instead S3Delete.", + "syntax": "s3deletebucket( bucketName )", + "returns": "query", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket to list objects from.", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "force", + "description": "Also delete bucket if it has content.", + "type": "boolean", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3download.json b/data/en/s3download.json new file mode 100644 index 000000000..6633630e7 --- /dev/null +++ b/data/en/s3download.json @@ -0,0 +1,66 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3download.html"}}, + "name": "s3download", + "description": "Downloads an object from an S3 bucket. \nIt can save the object to a specified path, return its content directly, or process the content in parts through a provided closure or UDF (User-Defined Function).", + "syntax": "s3download( bucketName, objectName )", + "returns": "any", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket to download.", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object to download.", + "aliases": "object", + "type": "string", + "required": true + }, + { + "name": "target", + "description": "Optional. Defines the target where the downloaded data will be directed.\n\nIf a file path is provided, the data is saved to that path, the file path must be provided with help of the function \"fileOpen\" like this [fileOpen(path,\"write\")].\n\nIf a closure or function is given, it will be invoked with parts of the downloaded data as its argument.\nThe function should accept a single argument named 'line' for line-by-line processing,\n'string{Number}' for string blocks of a specified size,\nor 'binary{Number}' for binary blocks of a specified size.\n\nThe function should return a boolean value: returning false will stop further reading from S3,\nwhile true will continue the process.\n\nIf this argument is omitted, the function returns the downloaded data directly.", + "aliases": "closure,udf,function,path,file", + "type": "any", + "required": false + }, + { + "name": "charset", + "description": "charset to use to store the content.", + "default": "", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 `accessKeyId`, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "The provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3exists.json b/data/en/s3exists.json new file mode 100644 index 000000000..0e9b1cefc --- /dev/null +++ b/data/en/s3exists.json @@ -0,0 +1,52 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3exists.html"}}, + "name": "s3exists", + "description": "Checks if given object exists in", + "syntax": "s3exists( bucketName )", + "returns": "boolean", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket of your object to check", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to check", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3generatepresignedurl.json b/data/en/s3generatepresignedurl.json new file mode 100644 index 000000000..8c5cb82a3 --- /dev/null +++ b/data/en/s3generatepresignedurl.json @@ -0,0 +1,129 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3generatepresignedurl.html"}}, + "name": "s3generatepresignedurl", + "description": "Generates a presigned URL pointing to the object given. You can provide the endpoint as a bucket/object definition (S3AddACL(bucket:\"mybucket\",object:\"myobject.txt\") ) or as a virtual filesystem path (S3AddACL(path:\"s3://mybucket/myobject.txt\") ).", + "syntax": "s3generatepresignedurl( bucketNameOrPath )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "bucketNameOrPath", + "description": "This can be the bucketname or simple the virtual filesystem point for the file (if object name is no defined)", + "aliases": "bucket,bucketName,path", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "expireDate", + "description": "Date time when the URL should expire.", + "aliases": "expire", + "type": "datetime", + "required": false + }, + { + "name": "httpMethod", + "description": "The desired HTTP method (e.g., GET, PUT). Defaults to GET.", + "aliases": "method", + "type": "string", + "required": false + }, + { + "name": "sseAlgorithm", + "description": "The desired server-side encryption algorithm, valid values are AES256 or KMS.", + "aliases": "algorithm", + "type": "string", + "required": false + }, + { + "name": "sseCustomerKey", + "description": "The server-side encryption customer-provided key.", + "aliases": "customerKey", + "type": "string", + "required": false + }, + { + "name": "checksum", + "description": "The base64 encoded MD5 checksum of the object's content.", + "aliases": "contentMd5", + "type": "string", + "required": false + }, + { + "name": "type", + "description": "The MIME type of the object (e.g., \"text/plain\").", + "aliases": "contentType", + "type": "string", + "required": false + }, + { + "name": "disposition", + "description": "Specifies presentational information for the object, like \"attachment; filename=\\\"filename.pdf\\\"\".", + "aliases": "contentDisposition", + "type": "string", + "required": false + }, + { + "name": "encoding", + "description": "Specifies content encodings applied to the object, like gzip.", + "aliases": "contentEncoding", + "type": "string", + "required": false + }, + { + "name": "version", + "description": "The version ID of the object if versioning is enabled.", + "aliases": "versionId", + "type": "string", + "required": false + }, + { + "name": "zeroByte", + "description": "A flag to specify if the object has zero-byte content.", + "aliases": "zeroByteContent", + "type": "boolean", + "required": false + }, + { + "name": "responseHeaders", + "description": "Struct of custom response headers for custom metadata prefixed with \"x-amz-meta-\" (prefix is optional, function will add it if missed).", + "aliases": "customResponseHeaders", + "type": "struct", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3generateuri.json b/data/en/s3generateuri.json new file mode 100644 index 000000000..590dfe1d8 --- /dev/null +++ b/data/en/s3generateuri.json @@ -0,0 +1,68 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3generateuri.html"}}, + "name": "s3generateuri", + "description": "Generates a URI endpoint pointing to the object given. You can provide the endpoint as a bucket/object definition (S3AddACL(bucket:\"mybucket\",object:\"myobject.txt\") ) or as a virtual filesystem path (S3AddACL(path:\"s3://mybucket/myobject.txt\") ).", + "syntax": "s3generateuri( bucketNameOrPath )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "bucketNameOrPath", + "description": "This can be the bucketname or simple the virtual filesystem point for the file (if object name is no defined)", + "aliases": "bucket,bucketName,path", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "type", + "description": "Defines the style/type created, possible values are:\n\n- virtualhost\n- path\n- arn\n- s3\n\nFor more details, please see:\n\n[Methods for accessing a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html)\n[Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)", + "default": "virtualhost", + "aliases": "style", + "type": "string", + "required": false + }, + { + "name": "secure", + "description": "Should a secure URL (https) be created or not. Only applies to type virtualhost and path.", + "default": "true", + "aliases": "secured", + "type": "boolean", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3getacl.json b/data/en/s3getacl.json new file mode 100644 index 000000000..c7c3f446c --- /dev/null +++ b/data/en/s3getacl.json @@ -0,0 +1,53 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3getacl.html"}}, + "name": "s3getacl", + "description": "Returns an array of structures, with each structure representing an ACL (Access Control List) grant. You can provide the endpoint as a bucket/object definition (S3GetACL(bucket:\"mybucket\",object:\"myobject.txt\") ) or as a virtual filesystem path (S3GetACL(path:\"s3://mybucket/myobject.txt\") ).", + "syntax": "s3getacl( bucketNameOrPath )", + "returns": "object", + "type": "function", + "params": [ + { + "name": "bucketNameOrPath", + "description": "This can be the bucketname or a virtual filesystem path for a file/directory (example \"s3://mybucket/myobject.txt\").", + "aliases": "bucket,bucketName,path", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument.", + "default": "", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3getmetadata.json b/data/en/s3getmetadata.json new file mode 100644 index 000000000..4cdd976f3 --- /dev/null +++ b/data/en/s3getmetadata.json @@ -0,0 +1,53 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3getmetadata.html"}}, + "name": "s3getmetadata", + "description": "Returns the metadata related to the object or bucket. You can provide the endpoint as a bucket/object definition (S3GetMetaData(bucket:\"mybucket\",object:\"myobject.txt\") ) or as a virtual filesystem path (S3GetMetaData(path:\"s3://mybucket/myobject.txt\") ).", + "syntax": "s3getmetadata( bucketNameOrPath )", + "returns": "struct", + "type": "function", + "params": [ + { + "name": "bucketNameOrPath", + "description": "This can be the bucketname or a virtual filesystem path for a file/directory (example \"s3://mybucket/myobject.txt\").", + "aliases": "bucket,bucketName,path", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument.", + "default": "", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3getversioninfo.json b/data/en/s3getversioninfo.json new file mode 100644 index 000000000..cedaa50ce --- /dev/null +++ b/data/en/s3getversioninfo.json @@ -0,0 +1,52 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3getversioninfo.html"}}, + "name": "s3getversioninfo", + "description": "Returns version information as a query for a specific object or bucket.", + "syntax": "s3getversioninfo( bucketName )", + "returns": "query", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket to get info for.", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket to get info for. If not defined, info of the bucket is returned.", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId. If not defined, checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey. If not defined, checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretKey,awsSecretKey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "The provider to connect to. If not set, Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "Timeout for this execution (in milliseconds).", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3listbucket.json b/data/en/s3listbucket.json new file mode 100644 index 000000000..4984fdf21 --- /dev/null +++ b/data/en/s3listbucket.json @@ -0,0 +1,60 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3listbucket.html"}}, + "name": "s3listbucket", + "description": "List all objects in a bucket", + "syntax": "s3listbucket( bucketName )", + "returns": "query", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket to list objects from.", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "listener", + "description": "Optional. Defines the target where the downloaded data will be directed. \nIf a file path is provided, the data is saved to that path, the file path must be provided with help of the function \"fileOpen\" like this [fileOpen(path,\"write\")]. \nIf a closure or function is given, it will be invoked with parts of the downloaded data as its argument. \nThe function should accept a single argument named 'line' for line-by-line processing, \n'string{Number}' for string blocks of a specified size, \nor 'binary{Number}' for binary blocks of a specified size. \nThe function should return a boolean value: returning false will stop further reading from S3, \nwhile true will continue the process. \nIf this argument is omitted, the function returns the downloaded data directly.", + "aliases": "closure,udf,function,component", + "type": "any", + "required": false + }, + { + "name": "blockfactor", + "description": "", + "default": "1000", + "aliases": "maxKeys,blockSize", + "type": "numeric", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].\n", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].\n", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3listbuckets.json b/data/en/s3listbuckets.json new file mode 100644 index 000000000..8eb5cc4f6 --- /dev/null +++ b/data/en/s3listbuckets.json @@ -0,0 +1,38 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3listbuckets.html"}}, + "name": "s3listbuckets", + "description": "List all buckets", + "syntax": "s3listbuckets( )", + "returns": "query", + "type": "function", + "params": [ + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3move.json b/data/en/s3move.json new file mode 100644 index 000000000..beb4d5245 --- /dev/null +++ b/data/en/s3move.json @@ -0,0 +1,80 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3move.html"}}, + "name": "s3move", + "description": "Moves an object in S3 from one bucket to an other.", + "syntax": "s3move( srcBucketName, srcObjectName, trgBucketName )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "srcBucketName", + "description": "Name of the source bucket of your object to move.", + "aliases": "srcBucket,sourceBucketName,sourceBucket", + "type": "string", + "required": true + }, + { + "name": "srcObjectName", + "description": "Name of the source object (path) within the bucket of your object to move.", + "aliases": "sourceObjectName,srcObject,sourceObject", + "type": "string", + "required": true + }, + { + "name": "trgBucketName", + "description": "Name of the target bucket of your object to move", + "aliases": "trgBucket,targetBucketName,targetBucket", + "type": "string", + "required": true + }, + { + "name": "trgObjectName", + "description": "Name of the target object (path)for the target bucket. If not defined the source object name is used.", + "aliases": "targetObjectName,trgObject,targetObject", + "type": "string", + "required": false + }, + { + "name": "acl", + "description": "an array of struct where each struct represents an ACL grant", + "aliases": "aclObject", + "type": "object", + "required": false + }, + { + "name": "location", + "description": "location of the S3 storage.", + "aliases": "region", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3read.json b/data/en/s3read.json new file mode 100644 index 000000000..5c7114e82 --- /dev/null +++ b/data/en/s3read.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3read.html"}}, + "name": "s3read", + "description": "Reads an object from S3 as a string.", + "syntax": "s3read( bucketName, objectName )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket of your object to read", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read", + "aliases": "object,path", + "type": "string", + "required": true + }, + { + "name": "charset", + "description": "charset to use to store the content.", + "default": "UTF-8", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].\n", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].\n", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3readbinary.json b/data/en/s3readbinary.json new file mode 100644 index 000000000..761002665 --- /dev/null +++ b/data/en/s3readbinary.json @@ -0,0 +1,52 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3readbinary.html"}}, + "name": "s3readbinary", + "description": "Reads an object from S3 as a binary.", + "syntax": "s3readbinary( bucketName, objectName )", + "returns": "binary", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket of your object to read", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read", + "aliases": "object,path", + "type": "string", + "required": true + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].\n", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].\n", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3setacl.json b/data/en/s3setacl.json new file mode 100644 index 000000000..b8d52a49e --- /dev/null +++ b/data/en/s3setacl.json @@ -0,0 +1,60 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3setacl.html"}}, + "name": "s3setacl", + "description": "Sets ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object definition (S3SetACL(bucket:\"mybucket\",object:\"myobject.txt\",acl:data) ) or as a virtual filesystem path (S3SetACL(path:\"s3://mybucket/myobject.txt\",acl:data) ).", + "syntax": "s3setacl( bucketNameOrPath, aclObject )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "bucketNameOrPath", + "description": "This can be the bucketname or a virtual filesystem path for a file/directory (example \"s3://mybucket/myobject.txt\").", + "aliases": "bucket,bucketName,path", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument.", + "default": "", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "aclObject", + "description": "an array of struct where each struct represents an ACL grant", + "aliases": "acl", + "type": "object", + "required": true + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3setmetadata.json b/data/en/s3setmetadata.json new file mode 100644 index 000000000..25367ae2d --- /dev/null +++ b/data/en/s3setmetadata.json @@ -0,0 +1,59 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3setmetadata.html"}}, + "name": "s3setmetadata", + "description": "Sets the metadata on bucket or object. You can provide the endpoint as a bucket/object definition (S3SetMetaData(bucket:\"mybucket\",object:\"myobject.txt\",metadata:data) ) or as a virtual filesystem path (S3SetMetaData(path:\"s3://mybucket/myobject.txt\",metadata:data) ).", + "syntax": "s3setmetadata( bucketNameOrPath, metadata )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "bucketNameOrPath", + "description": "This can be the bucketname or a virtual filesystem path for a file/directory (example \"s3://mybucket/myobject.txt\").", + "aliases": "bucket,bucketName,path", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument.", + "default": "", + "aliases": "object,path", + "type": "string", + "required": false + }, + { + "name": "metadata", + "description": "", + "type": "struct", + "required": true + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3upload.json b/data/en/s3upload.json new file mode 100644 index 000000000..e2aebfb6f --- /dev/null +++ b/data/en/s3upload.json @@ -0,0 +1,72 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3upload.html"}}, + "name": "s3upload", + "description": "Uploads a file to S3.", + "syntax": "s3upload( bucketName, objectName, source )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket of your object to write", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to write", + "aliases": "object", + "type": "string", + "required": true + }, + { + "name": "source", + "description": "Source file to write to S3. A string path to a file or a object created with the function \"fileOpen\".", + "type": "object", + "required": true + }, + { + "name": "acl", + "description": "an array of struct where each struct represents an ACL grant", + "aliases": "aclObject", + "type": "object", + "required": false + }, + { + "name": "location", + "description": "location of the S3 storage.", + "aliases": "region", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/s3write.json b/data/en/s3write.json new file mode 100644 index 000000000..673180e6e --- /dev/null +++ b/data/en/s3write.json @@ -0,0 +1,87 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/s3write.html"}}, + "name": "s3write", + "description": "Writes a value to S3.", + "syntax": "s3write( bucketName, objectName, value )", + "returns": "void", + "type": "function", + "params": [ + { + "name": "bucketName", + "description": "Name of the bucket of your object to read", + "aliases": "bucket", + "type": "string", + "required": true + }, + { + "name": "objectName", + "description": "Name of the object (path) within the bucket of your object to read", + "aliases": "object,path", + "type": "string", + "required": true + }, + { + "name": "value", + "description": "value to store on S3.", + "aliases": "content", + "type": "object", + "required": true + }, + { + "name": "charset", + "description": "charset to use to store the content.", + "default": "UTF-8", + "type": "string", + "required": false + }, + { + "name": "mimeType", + "description": "MimeType of the value you are storing.", + "default": "UTF-8", + "type": "string", + "required": false + }, + { + "name": "acl", + "description": "an array of struct where each struct represents an ACL grant", + "aliases": "aclObject", + "type": "object", + "required": false + }, + { + "name": "location", + "description": "location of the S3 storage.", + "aliases": "region", + "type": "string", + "required": false + }, + { + "name": "accessKeyId", + "description": "S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].\n", + "aliases": "accessKey,awsAccessKeyId,awsAccessKey", + "type": "string", + "required": false + }, + { + "name": "secretAccessKey", + "description": "S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].\n", + "aliases": "secretkey,awsSecretkey,awsSecretAccessKey", + "type": "string", + "required": false + }, + { + "name": "host", + "description": "the provider to connect, if not set Amazon AWS is used.", + "aliases": "provider,server", + "type": "string", + "required": false + }, + { + "name": "timeout", + "description": "timeout for this execution", + "default": "10000", + "type": "number", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/sanitize.json b/data/en/sanitize.json new file mode 100644 index 000000000..8e63096b2 --- /dev/null +++ b/data/en/sanitize.json @@ -0,0 +1,25 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/sanitize.html"}}, + "name": "sanitize", + "description": "Detects and masks sensitive information (such as passwords, API keys, tokens, etc.) from a given string. \nThe function identifies patterns commonly used for sensitive data and replaces them with a mask.", + "syntax": "sanitize( text )", + "returns": "string", + "type": "function", + "params": [ + { + "name": "text", + "description": "The input string to be sanitized.", + "aliases": "string", + "type": "string", + "required": true + }, + { + "name": "replacement", + "description": "The replacement string to use as a mask for sensitive data. If not specified, defaults to \"****\".", + "default": "****", + "aliases": "mask", + "type": "string", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/savecontent.json b/data/en/savecontent.json new file mode 100644 index 000000000..941acf824 --- /dev/null +++ b/data/en/savecontent.json @@ -0,0 +1,31 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/savecontent.html"}}, + "name": "savecontent", + "description": "Saves the generated content inside the tag body in a variable.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "variable", + "description": "The name of the variable in which to save the generated content inside the tag.", + "default": false, + "type": "string", + "required": true + }, + { + "name": "trim", + "description": "trim result", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "append", + "description": "if true, the saved content will be appended to an already existing variable instead of overwriting it.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/schedule.json b/data/en/schedule.json new file mode 100644 index 000000000..380bd1c90 --- /dev/null +++ b/data/en/schedule.json @@ -0,0 +1,214 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/schedule.html"}}, + "name": "schedule", + "description": "Provides a programmatic interface to the scheduling engine. You can run a specified\npage at scheduled intervals with the option to write out static HTML pages. This lets you offer users\naccess to pages that publish data, such as reports, without forcing users to wait while a database transaction\nis performed in order to populate the data on the page.", + "syntax": "", + "returns": "void", + "type": "tag", + "params": [ + { + "name": "action", + "description": "- delete: deletes the specified task\n- update: updates an existing task or creates a new task, if one with the name specified by the task attribute does not exist\n- run: executes the specified task\n- list: list all scheduled tasks defined\n- pause: pause execution of the defined scheduled task\n- resume: resume execution of a paused scheduled task", + "default": false, + "type": "string", + "required": true + }, + { + "name": "serverpassword", + "description": "allow you to access filesystem, also when access is denied for your context", + "default": false, + "type": "string", + "required": false + }, + { + "name": "hidden", + "description": "if set to true the scheduled task is not displayed in the Lucee Administrator.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "readonly", + "description": "if set to true the scheduled task can not be modified or deleted in the Lucee Administrator.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "task", + "description": "The name of the task to delete, update, or run.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "operation", + "description": "The type of operation the scheduler performs when executing this task.\n\n- HTTPRequest: make a http(s) request to the url provided\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "paused", + "description": "if set to true the scheduled task is paused.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "file", + "description": "Required with publish ='Yes' A valid filename for the published file.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "path", + "description": "Required with publish ='Yes' The path location for the published file.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "startdate", + "description": "Required when action ='update'. The date when scheduling of the task should start.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "starttime", + "description": "Required when creating tasks with action = 'update'. Enter a value in seconds. The time when\n\tscheduling of the task starts.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "url", + "description": "Required when action = 'update'. The URL to be executed.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "publish", + "description": "Specifies whether the result should be saved to a file.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "enddate", + "description": "The date when the scheduled task ends.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "endtime", + "description": "The time when the scheduled task ends. Enter a value in seconds.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "interval", + "description": "Required when creating tasks with action = 'update'. Interval at which task should be scheduled.\nCan be set in seconds or as Once, Daily, Weekly, and Monthly. The default interval is one hour. The\nminimum interval is 10 seconds.\n", + "default": false, + "type": "string", + "required": false + }, + { + "name": "requesttimeout", + "description": "Customizes the requestTimeOut for the task operation. Can be used to extend the default timeout\nfor operations that require more time to execute. Value in seconds.\n", + "default": false, + "type": "any", + "required": false + }, + { + "name": "username", + "description": "Username if URL is protected.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "password", + "description": "Password if URL is protected.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyserver", + "description": "Host name or IP address of a proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxyuser", + "description": "User name to provide to the proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "proxypassword", + "description": "Password to provide to the proxy server.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "useragent", + "description": "User agent request header.", + "minimum_version": "str", + "default": false, + "type": "string", + "required": false + }, + { + "name": "resolveurl", + "description": "Specifies whether to resolve links in the result page to absolute references.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "port", + "description": "The port number on the server from which the task is being scheduled. Default is 80. When used\nwith resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved\nto preserve links in the retrieved document.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "proxyport", + "description": "The port number on the proxy server from which the task is being requested. Default is 80. When\nused with resolveURL, the URLs of retrieved documents that specify a port number are automatically\nresolved to preserve links in the retrieved document.", + "default": false, + "type": "any", + "required": false + }, + { + "name": "result", + "description": "Return variable name of action list. Result attribute doesn't work with other actions.", + "default": false, + "type": "string", + "required": false + }, + { + "name": "autodelete", + "description": "if set to true, the scheduled task get deleted when there is no possible future execution.", + "default": false, + "type": "boolean", + "required": false + }, + { + "name": "unique", + "description": "if set to true, the scheduled task is only executed once at time.if a task is still running from previous round no new task is started.", + "default": false, + "type": "boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/data/en/script.json b/data/en/script.json new file mode 100644 index 000000000..cb1ffc99a --- /dev/null +++ b/data/en/script.json @@ -0,0 +1,15 @@ +{ + "engines": {"lucee": {"docs": "https://docs.lucee.org/reference/functions/script.html"}}, + "name": "script", + "description": "Encloses a code segment containing cfscript.", + "syntax": "