GridCraft.Util | GridCraft

GridCraft.Util

Generic utility functions

API Overview #

Deprecateds - API features which will be removed in an upcoming release
- getApplicationIconDataUri
Functions - API calls offered directly by the extension

API Documentation #

Deprecateds #

getApplicationIconDataUri #

Signature	`GridCraft.Util.getApplicationIconDataUri(string, hs.application) -> string or nil`
Type	Deprecated
Description	Get an application icon as a data: URI
Parameters	appName - The name of the application (used for logging) application - The hs.application object of the application
Returns	A string containing a data URI with base64-encoded PNG data of the application icon, or nil if the icon cannot be retrieved
Notes	We don’t use this internally so it will be removed in the future.

Functions #

fileContents #

Signature	`GridCraft.Util.fileContents(string) -> string or nil`
Type	Function
Description	Get the contents of a file at a given path
Parameters	fullPath - The full path to the file

base64 #

Signature	`GridCraft.Util.base64(string) -> string`
Type	Function
Description	Encode a string in base64 format
Parameters	data - The string to encode

findApplicationPath #

Signature	`GridCraft.Util.findApplicationPath(string) -> string or nil`
Type	Function
Description	Find an application path by its name
Parameters	appName - The name of the application to find

getBasename #

Signature	`GridCraft.Util.getBasename(string) -> string`
Type	Function
Description	Get the last component of a file path, or “/” if the path is the root directory
Parameters	path - The file path to get the basename from