Class HSApplication

constructor

• new HSApplication(): HSApplication

  Returns HSApplication

ReadonlyallWindows

ReadonlybundleID

ReadonlybundlePath

ReadonlyfocusedWindow

ReadonlyisActive

isHidden

ReadonlyisRunning

Readonlykind

ReadonlymainWindow

Readonlypid

Readonlytitle

ReadonlyvisibleWindows

activate

• activate(allWindows?: boolean): void

  Bring this application to the foreground

  Parameters

  • OptionalallWindows: boolean

    Pass true to raise all application windows. Defaults to false.

  Returns void

axElement

• axElement(): HSAXElement | null

  The application's HSAXElement object, for use with the hs.ax APIs

  Returns HSAXElement | null

  An HSAXElement object, or nil if it could not be obtained

findMenuItemByName

• findMenuItemByName(name: string): Record<string, any> | null

  Find a menu item by searching all menus for a matching title (case-insensitive)

  Parameters

  • name: string

    The menu item title to search for

  Returns Record<string, any> | null

  An object with title and enabled keys, or null if not found

findMenuItemByPath

• findMenuItemByPath(path: string[]): Record<string, any> | null

  Find a menu item by following a hierarchical path of titles

  Parameters

  • path: string[]

    An array of menu titles forming a path from the top-level menu to the item, e.g. ["Edit", "Select All"]

  Returns Record<string, any> | null

  An object with title and enabled keys, or null if not found

findWindow

• findWindow(pattern: string): HSWindow[]

  Find windows whose title contains the given string (case-insensitive)

  Parameters

  • pattern: string

    A string to search for in window titles

  Returns HSWindow[]

  An array of matching HSWindow objects

getMenuItems

• getMenuItems(): Record<string, any>[] | null

  Get the full menu structure of this application

  Returns Record<string, any>[] | null

  An array of top-level menu objects, each with title and items keys, or null if unavailable

  Remarks

  This traverses the accessibility hierarchy and may be slow for apps with large menus.

getWindow

• getWindow(title: string): HSWindow | null

  Get the first window with exactly the given title

  Parameters

  • title: string

    The exact window title to search for

  Returns HSWindow | null

  The matching HSWindow, or null if not found

hide

• hide(): void

  Hide this application and all its windows

  Returns void

kill

• kill(): boolean

  Terminate the application

  Returns boolean

  True if the application was terminated, otherwise false

kill9

• kill9(): boolean

  Force-terminate the application

  Returns boolean

  True if the application was force-terminated, otherwise false

selectMenuItemByName

• selectMenuItemByName(name: string): boolean

  Click a menu item found by searching all menus for a matching title (case-insensitive)

  Parameters

  • name: string

    The menu item title to search for

  Returns boolean

  true if the menu item was found and clicked, false otherwise

selectMenuItemByPath

• selectMenuItemByPath(path: string[]): boolean

  Click a menu item found by following a hierarchical path of titles

  Parameters

  • path: string[]

    An array of menu titles forming a path from the top-level menu to the item, e.g. ["File", "New Window"]

  Returns boolean

  true if the menu item was found and clicked, false otherwise

unhide

• unhide(): void

  Unhide this application

  Returns void