Login
1
Introduction
1.1. About JavaScript
1.2. HASH files
1.3. JS files in #/API
2
General functions
2.1. if
(criteria)
2.2. else
2.3. function
name, params
2.4. return
value
2.5. break
2.6. continue
2.7. typeof
value
2.8. switch
(value)
2.9. import
filename
2.10. try
statements, catch, finally
3
Directives
3.1. Include directive
(file)
3.2. Master directive
(file)
4
Chapter functions
4.1. Chinit
(name)
4.2. Chstep
(name)
4.3. Chdestep
(name)
4.4. Chpush
(name)
4.5. Chpop
(name)
5
Date and time functions
5.1. dateDiff
(date1, date2)
5.2. Formatting dates
5.3. new Date()
5.4. addSeconds
(datetime, seconds)
5.5. addMinutes
(datetime, minutes)
5.6. addHours
(datetime, hours)
5.7. addDays
(date, days)
5.8. addMonths
(datetime, months)
5.9. addYears
(datetime, years)
6
Filesystem functions
6.1. extractBase64Images
(html)
6.2. getFolderProps
(folderPath)
6.3. getEmbeddedFolderFile
(folderPath, embeddedFilename)
6.4. saveFolderProps
(folderPath, properties)
6.5. saveEmbeddedFolderFile
(folderPath, embeddedFilename, data)
6.6. extractAndEmbedBase64Images
(filePath, propertyFilter)
6.7. createFolder
(folderPath, folderType, folderData)
6.8. deleteFile
(filePath)
6.9. deleteFolder
(folderPath)
6.10. fileExists
(filePath)
6.11. folderExists
(path)
6.12. getEmbeddedFile
(path, id)
6.13. getEmbeddedTextFile
(path, id, encoding)
6.14. Include
(path, template)
6.15. getEmbeddedFileSize
(path, id)
6.16. getFiles
(path, searchPattern, depth, mode)
6.17. getFolder
(path)
6.18. getFolders
(path, searchPattern, depth)
6.19. getFile
(filepath, metadata)
6.20. getJson
(filepath)
6.21. linkFile
(embeddedId, filename)
6.22. listFiles
(path, searchPattern, tags, recursive, metaOnly)
6.23. listFolders
(path, searchPattern, recursive, includeCounters)
6.24. linkImage
(path, width, height, mode)
6.25. Image scaling
6.26. loadExcel
(filename, column, row, sheet)
6.27. moveFile
(filePath, toPath)
6.28. moveFolder
(folderPath, destinationPath)
6.29. renameFile
(filePath, newName)
6.30. saveEmbeddedFile
(filePath, filename, data)
6.31. saveFile
(filePath, data, schema, ensurePath)
6.32. patchFile
(filePath, patchData)
6.33. saveJson
(filePath, data, ensurePath)
6.34. logJson
(filePath, data)
7
Math functions
7.1. Math calculations
7.2. Math.atan
7.3. Math.random
7.4. Math.cos
7.5. Math.PI
7.6. Math.sin
(value)
7.7. Math.sqrt
(value)
7.8. Math.tan
(angle)
7.9. Math.abs
(value)
7.10. Math.pow
(base, exponent)
7.11. Math.ceil
(value)
7.12. Math.floor
(value)
7.13. Math.round
(value)
8
Array functions
8.1. Array.concat
(list)
8.2. Array.every
(callback)
8.3. Array.filter
(filter)
8.4. Array.find
(filter)
8.5. Array.forEach
(callback)
8.6. Array.groupBy
(key)
8.7. Array.indexOf
(item)
8.8. Array.join
(seperator)
8.9. Array.length
8.10. Array.pop
8.11. Array.push
(item)
8.12. Array.reverse
8.13. Array.shift
8.14. Array.isArray
8.15. Array.slice
(start, end)
8.16. Array.some
(evaluator)
8.17. Array.sort
(sorter)
8.18. Array.splice
(start, deleteCount, item1...N)
9
Network functions
9.1. getRemoteIp
9.2. downloadFromUrl
(url)
9.3. downloadFromUrl64
(url)
9.4. httpGet
(url, headers)
9.5. httpPut
(url, data, headers)
9.6. httpPost
(url, data, headers)
9.7. httpFormPost
(url, data, headers)
9.8. getUploadBase64
(filename)
9.9. getUploads
10
Output functions
10.1. process
(script, cursor)
10.2. console.assert
(condition, message)
10.3. setContentDisposition
(type, filename)
10.4. htmlToXlsx
(filename, html)
10.5. htmlToPdf
(filename, html, usePrintCss)
10.6. base64
(data)
10.7. setMime
(mime)
10.8. write
(text)
10.9. setResultCode
(code)
10.10. getHeader
(name)
10.11. setHeader
(name, value)
10.12. request
10.13. format
(value, format)
10.14. Formatting numbers
10.15. HTML.format
(html)
10.16. JSON.format
(json)
10.17. redirect
(url)
10.18. JSON.parse
(json)
10.19. JSON.stringify
(value)
10.20. console.log
(text)
10.21. setCulture
(culture)
10.22. textToHtml
(text)
10.23. Chr
(code, ...)
10.24. setExecutionTimeout
(timeout)
11
String functions
11.1. guid
11.2. guid2
11.3. md5
(text)
11.4. sha256
(text)
11.5. Template literal (template strings)
11.6. textDecode
(bytes, encoding)
11.7. textEncode
(text, encoding)
11.8. toHtml
(text, text2, ...)
11.9. encodeFilename
(filename)
11.10. decodeFilename
(filename)
11.11. encodeURI
(text)
11.12. encodeURIComponent
(text)
11.13. htmlAttributeEncode
(text)
11.14. htmlEncode
(text)
11.15. removeEmptyLines
(text)
11.16. String.concat
(string1, string2, ...)
11.17. String.includes
(search)
11.18. String.substring
(start, end)
11.19. String.indexOf
(text)
11.20. String.lastIndexOf
(text)
11.21. String.normalize
11.22. String.repeat
(times)
11.23. String.replace
(find, replace)
11.24. String.split
(seperator)
11.25. String.endsWith
(text)
11.26. String.startsWith
(text)
11.27. String.trim
11.28. stripTags
(html)
11.29. urlEncode
(text)
12
Validation functions
12.1. isNumber
(value, minValue, maxValue)
12.2. isString
(value, minLength, maxLength)
12.3. areEqual
(value1, value2)
12.4. areNotEqual
(value1, value2)
12.5. isNull
(value)
12.6. isNotNull
(value)
12.7. isName
(value)
12.8. isEmail
(value)
12.9. assert
(description, resultCode)
12.10. isDate
(value)
12.11. isDateTime
(value)
13
Share functions
13.1. download
(file, template, preview)
13.2. getFileShares
(path)
13.3. addFileShare
(file, user, access, subject, message)
13.4. removeFileShare
(file, user)
13.5. sendEmail
(file, template, receiver, subject, message)
13.6. downloadEmbedded
(file, embeddedId, filename)
13.7. generateDocument
(file, template)
13.8. sendForm
(form, subject, sendTo, smtp, subjectPrefix, addSenderInfo)
13.9. downloadBytes
(data, filename, preview)
14
Authentication
14.1. writeJwt
(userinfo)
14.2. denyAccess
14.3. flagActivity
14.4. deleteJwt
14.5. getProfilePictureUrl
(user)
15
Mail functions
15.1. pop3.pop
(options)
15.2. pop3.delete
(options, identifier)
15.3. pop3.get
(options, identifier)
15.4. pop3.getHeader
(options, identifier)
15.5. smtp.send
(config, message)
15.6. imap.connect
(config)
15.7. imap.getCount
(session, folder)
15.8. imap.delete
(session, message)
15.9. imap.getMessage
(session, index / uid, headersOnly, folder)
15.10. imap.disconnect
(connection)
16
Counter functions
16.1. counters.set
(name, value, counterFile)
16.2. counters.get
(name, counterFile)
16.3. counters.inc
(name, value, counterFile)
Home
JavaScript
Validation functions
Validation functions
Helper functions to easily validate values in API functions.
isNumber
(value, minValue, maxValue)
Checks if specified value is a number.
isString
(value, minLength, maxLength)
Validates that a variable is a string with atleast one or more characters (as specified).
areEqual
(value1, value2)
Checks if value1 and value2 are equal.
areNotEqual
(value1, value2)
Checks that two values are not equal.
isNull
(value)
Checks if specified value is null.
isNotNull
(value)
Checks if specified value is not null.
isName
(value)
Checks for first name and last name in string.
isEmail
(value)
Validates if string is an email.
assert
(description, resultCode)
Throws a validation error if condition is false. Handy to use for validating arguments in an API function.
isDate
(value)
Checks if value is a date type.
isDateTime
(value)
Checks if value is a datetime type.
