Util

Util — File providing certain utility functions

Functions

Description

This file includes certain useful utility functions such as running external commands. It is generally a good idea to use the functions defined here instead of tapping into GLib directly since this adds some wrappers around the functions that make them more Cinnamon-friendly and provides helpful error messages.

Functions

findUrls ()


findUrls (str);

Searches str for URLs and returns an array of objects with url properties showing the matched URL string, and pos properties indicating the position within str where the URL was found.

Parameters

str

string to find URLs in

 

Returns

the list of match objects, as described above


spawn ()


spawn (argv);

Runs argv in the background, handling any errors that occur when trying to start the program.

Parameters

argv

an argv array

 

spawn_async ()


spawn_async (args,
             callback);

Asynchronously Runs the command passed to args. When the command is complete, the callback will be called with the contents of stdout from the command passed as the only argument.

Parameters

args

an array containing all arguments of the command to be run

 

callback

the callback to run when the command has completed

 

spawnCommandLine ()


spawnCommandLine (command_line);

Runs command_line in the background, handling any errors that occur when trying to parse or start the program.

Parameters

command_line

a command line

 

trySpawn ()


trySpawn (argv,
          doNotReap);

Runs argv in the background. If launching argv fails, this will throw an error.

Parameters

argv

an argv array

 

doNotReap

whether to set the DO_NOT_REAP_CHILD flag

 

trySpawnCommandLine ()


trySpawnCommandLine (command_line);

Runs command_line in the background. If launching command_line fails, this will throw an error.

Parameters

command_line

a command line

 

spawnCommandLineAsync ()


spawnCommandLineAsync (           command_line,
                       function   callback,
                       function   errback);

Runs command_line in the background. If the process exits without error, a callback will be called, or an error callback will be called if one is provided.

Parameters

command_line

a command line

 

callback

called on success

 

errback

called on error

 

killall ()


killall (processName);

Kills processName. If no process with the given name is found, this will fail silently.

Parameters

processName

a process name

 

latinise ()

string
latinise (string   string);

Parameters

string

a string

 

Returns

string, replaced accented chars


queryCollection ()


queryCollection (array     collection,
                 object    query,
                 boolean   indexOnly);

Returns (object|null): the matched object, or null if no object in the collection matches all conditions of the query.

Parameters

collection

an array of objects to query

 

query

key-value pairs to find in the collection

 

indexOnly

defaults to false, returns only the matching object's index if true.

 

getGObjectPropertyValues ()

object
getGObjectPropertyValues (GObject.Object   object);

Parameters

object

GObject to inspect

 

Returns

JS representation of the passed GObject