@ckirg/corelib - v0.4.1
    Preparing search index...

    Function getSysInfo

    • Main entry point for collecting system telemetry. Automatically detects the runtime and gathers relevant system, process, and environment information.

      Returns
          | {
              arch: Architecture;
              cwd: string;
              env: Record<string, string>;
              loadAvg: any;
              memory: {
                  external: number;
                  heapTotal: number;
                  heapUsed: number;
                  rss: number;
              };
              os: Platform;
              osVersion: any;
              pid: number;
              ppid: number;
              runtime: "node"
              | "bun";
              uptime: number;
          }
          | {
              arch: string;
              cwd: string;
              env: Record<string, string>;
              loadAvg: number[];
              memory: {
                  external: null;
                  heapTotal: null;
                  heapUsed: null;
                  rss: number | null;
              };
              os: string;
              osVersion: string
              | null;
              pid: number | null;
              ppid: number | null;
              runtime: string;
              uptime: number;
          }

      Comprehensive system information.

      • {
            arch: Architecture;
            cwd: string;
            env: Record<string, string>;
            loadAvg: any;
            memory: {
                external: number;
                heapTotal: number;
                heapUsed: number;
                rss: number;
            };
            os: Platform;
            osVersion: any;
            pid: number;
            ppid: number;
            runtime: "node"
            | "bun";
            uptime: number;
        }
        • arch: Architecture

          System architecture.

        • cwd: string

          Current working directory.

        • env: Record<string, string>

          Redacted environment variables.

        • loadAvg: any

          System load averages for 1, 5, and 15 minutes.

        • memory: { external: number; heapTotal: number; heapUsed: number; rss: number }

          Memory usage statistics.

          • external: number

            Memory used by C++ objects bound to JavaScript objects.

          • heapTotal: number

            Total heap size.

          • heapUsed: number

            Used heap size.

          • rss: number

            Resident Set Size.

        • os: Platform

          Operating system platform.

        • osVersion: any

          Operating system version/release.

        • pid: number

          Process ID.

        • ppid: number

          Parent process ID.

        • runtime: "node" | "bun"

          Current runtime name.

        • uptime: number

          Process uptime in seconds.

      • {
            arch: string;
            cwd: string;
            env: Record<string, string>;
            loadAvg: number[];
            memory: {
                external: null;
                heapTotal: null;
                heapUsed: null;
                rss: number | null;
            };
            os: string;
            osVersion: string
            | null;
            pid: number | null;
            ppid: number | null;
            runtime: string;
            uptime: number;
        }