SugarRush

import { SugarRush } from "https://gist.githubusercontent.com/MindfulMinun/80ac136be45a5eb0fd2d0793da27ebb9/raw/sugarrush.ts";

An IPC wrapper to interface with Hyprland compositors.

class SugarRush {

constructor(instanceSignature?: string);

private close1();

private async open1();

activewindow();

activeworkspace();

binds();

clients();

cursorpos();

decorations(query: string);

devices();

dismissnotify(count?: number);

dispatch<Dispatcher extends keyof DispatchersArgs>(dispatcher: Dispatcher, ...commands: DispatchersArgs[Dispatcher]);

async *events();

async hyprctl(cmd: string);

async hyprctlJson<T = unknown>(cmd: string);

instances();

layers();

layouts();

monitors();

notify({ icon, duration, color, message }: {

icon?: Icons;

duration?: number;

color?: number;

message: string;

});

version();

workspaces();

}

§Constructors

new SugarRush(instanceSignature?: string)

[src]

§Methods

close1() private

[src]

open1() private

[src]

Opens the IPC socket

activewindow()

[src]

Gets the active window and its properties

activeworkspace()

[src]

Gets the active workspace and its properties

binds()

[src]

Lists all registered binds

clients()

[src]

Lists all registered windows with their properties

cursorpos()

[src]

Gets the current cursor position in global layout coordinates

decorations(query: string)

[src]

List all decorations and their info

devices()

[src]

Lists all connected keyboards and mice

dismissnotify(count?: number)

[src]

Dismisses all or up to count notifications

dispatch<Dispatcher extends keyof DispatchersArgs>(dispatcher: Dispatcher, ...commands: DispatchersArgs[Dispatcher])

[src]

events()

[src]

hyprctl(cmd: string)

[src]

hyprctlJson<T = unknown>(cmd: string)

[src]

instances()

[src]

Lists all running instances of Hyprland with their info

layers()

[src]

Lists all the surface layers

layouts()

[src]

lists all layouts available (including plugin'd ones)

monitors()

[src]

Lists active outputs with their properties, 'monitors all' lists active and inactive outputs

notify({ icon, duration, color, message }: {

icon?: Icons;

duration?: number;

color?: number;

message: string;

})

[src]

Sends a notification using the built-in Hyprland notification system

version()

[src]

workspaces()

[src]