Global Functions
Global functions are independent utilities designed to support and enhance resource functionality. They provide tools that resources can leverage for efficient operations and interaction. Written in Apple PKL, these functions are built with flexibility in mind, allowing you to modify and extend them as needed to suit your specific use cases.
Below is a list of the global functions available for each resource:
API Request Functions
Note: Request functions does not work on Lambda mode. Doing so will cause an exception on the AI Agents.
| Function | Description |
|---|---|
| request.ID() | Retrieves the unique request UUID. |
| request.IP() | Retrieves the client IP address. |
| request.data() | Retrieves the request body data. |
| request.params("id") | Fetches the value of a specific HTTP parameter from the request. |
| request.header("id") | Fetches the value of a specific HTTP header from the request. |
| request.file("name") | Accesses details of an uploaded file, including its filepath and filetype. |
| request.filetype("name") | Retrieves the MIME type of an uploaded file by its name. |
| request.filepath("name") | Retrieves the file path of an uploaded file by its name. |
| request.filecount() | Returns the total number of uploaded files in the request. |
| request.files() | Retrieves a list of file paths for all uploaded files. |
| request.filetypes() | Retrieves a list of MIME types for all uploaded files. |
| request.filesByType("mimetype") | Retrieves file paths of all uploaded files matching the specified MIME type. |
| request.path() | Retrieves the URI path of the API request. |
| request.method() | Retrieves the HTTP method (e.g., GET, POST) of the API request. |
Data Folder Functions
| Function | Description |
|---|---|
| data.filepath("agent_name/version", "filename") | Returns the file path of a stored file within the data/ folder. Requires specifying the agent_name/version and the filename. |
Skip Condition Functions
| Function | Description |
|---|---|
| skip.ifFileExists("string") | Returns true if file exists; false otherwise |
| skip.ifFolderExists("string") | Returns true if folder exists; false otherwise |
| skip.ifFileIsEmpty("string") | Returns true if file is empty exists; false otherwise |
Document JSON Parsers
| Function | Description |
|---|---|
| document.JSONParser("string") | Parse a JSON String and returns a native Dynamic object |
| document.JSONParserMapping("string") | Parse a JSON String and returns a native Mapping object |
Document JSON, YAML and XML Generators
| Function | Description |
|---|---|
| document.JSONRenderDocument(Any) | Parse Any object and returns a JSON String |
| document.JSONRenderValue(Any) | Parse Any object and returns a JSON String Value |
| document.yamlRenderDocument(Any) | Parse Any object and returns a Yaml String |
| document.yamlRenderValue(Any) | Parse Any object and returns a Yaml String Value |
| document.xmlRenderDocument(Any) | Parse Any object and returns a XML String |
| document.xmlRenderValue(Any) | Parse Any object and returns a XML String Value |
PKL Modules
These PKL modules come pre-included in Kdeps via import "pkl:<module>". They are readily available for use via <functon>.<property> or <functon>.<methods>, allowing you to extend and enhance your resource functions further.
For detailed information on individual methods and properties, refer to the Apple PKL Documentation.
| Function | Description |
|---|---|
| test | A template for writing tests |
| math | Basic math constants and functions |
| platform | Information about the runtime platform |
| semver | Parsing, comparison, and manipulation of semantic version numbers |
| shell | Utilities for generating shell scripts. |