Nine Pomeranian Monsters

    @nodegui/os-utils
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.2 • Public • Published

    os-utils

    npm version

    A helper module which contains OS specific native features.

    Installation

    npm install @nodegui/os-utils
    

    Usage

    import { Dock } from "@nodegui/os-utils";
    
    console.log("Showing the Dock icon on macOS");
    Dock.show();
    console.log("Hiding the Dock icon on macOS");
    Dock.hide();
    import { AboutPanel } from "@nodegui/os-utils";
    
    console.log("Open the about panel on macOS");
    AboutPanel.open();
    console.log("Open the about panel on macOS with modified defaults");
    AboutPanel.open({ name: "Custom name", version: "2.3.5" });
    import { Info } from "@nodegui/os-utils";
    
    console.log("isDarkMode: " + Info.isDarkMode());

    Supported APIs

    macOS

    • Dock

      • show() - static method - Shows the Dock icon on macOS. Does nothing on other platforms.
      • hide() - static method - Hides the Dock icon on macOS. Does nothing on other platforms.
    • AboutPanel

      • open(options?: object) - static method - Opens the about panel on macOS. Does nothing on other platforms. options is optional and can contain the following strings: name, version, applicationVersion, and copyright. The default values are derived from Info.plist.
    • Info

      • isDarkMode - static method - Checks if the OS theme is dark mode in macOS. Does nothing on other platforms and returns false. Returns a boolean.

    License

    MIT

    Keywords

    none

    Install

    npm i @nodegui/os-utils

    DownloadsWeekly Downloads

    2

    Version

    1.1.2

    License

    MIT

    Unpacked Size

    14.4 kB

    Total Files

    31

    Last publish

    Collaborators

    • shirakaba
    • atulanand94
    • rahulgaba
    • kakulgupta
    • shubhamzanwar