escapeRegExp ()

escapeRegExp (str);

Escapes a string for use within a regular expression.

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.

spawn ()

spawn (argv);

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

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.

spawnCommandLine ()

spawnCommandLine (command_line);

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

trySpawn ()

trySpawn (argv,
          doNotReap);

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

trySpawnCommandLine ()

trySpawnCommandLine (command_line);

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

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.

spawnCommandLineAsyncIO ()

object
spawnCommandLineAsyncIO (           command,
                         function   callback,
                         object     opts);

Runs command in the background. Callback has three arguments - stdout, stderr, and exitCode.

killall ()

killall (processName);

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

latinise ()

string
latinise (string   string);

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.

findIndex ()

number
findIndex (array      array,
           function   callback);

find ()

any
find (array      array,
      function   callback);

each ()

each (function   callback);

Iteratee functions may exit iteration early by explicitly returning false.

filter ()

array
filter (array      array,
        function   callback);

map ()

array
map (array      array,
     function   callback);

tryFn ()

any
tryFn (function   callback,
       function   errCallback);

Try-catch can degrade performance in the function scope it is called in. By using a wrapper for try-catch, the function scope is reduced to the wrapper and not a potentially performance critical function calling the wrapper. Use of try-catch in any form will be slower than writing defensive code.

setTimeout ()

number
setTimeout (function   callback,
            number     ms);

Convenience wrapper for a Mainloop.timeout_add loop that returns false.

clearTimeout ()

clearTimeout (number   id);

Convenience wrapper for Mainloop.source_remove.

setInterval ()

number
setInterval (function   callback,
             number     ms);

Convenience wrapper for a Mainloop.timeout_add loop that returns true.

clearInterval ()

clearInterval (number   id);

Convenience wrapper for Mainloop.source_remove.

throttle ()

any
throttle (function   callback,
          number     interval,
          boolean    callFirst);

unref ()

unref (object   object,
       array    reserved);

This will iterate object and assign null to every property value except for keys specified in the reserved array. Calling unref() in an object that has many references can make garbage collection easier for the engine. This should be used at the end of the lifecycle for classes that do not reconstruct very frequently, as GC thrashing can reduce performance.

getGObjectPropertyValues ()

object
getGObjectPropertyValues (GObject.Object   object);

getDesktopActionIcon ()

getDesktopActionIcon (string   action);

Returns (string|null): Name of the icon associated with this action or null if not found