@el3um4s/ipc-for-electron-system-info/README.md

Allow the renderer to get information about the version of Electron, Chrome and NodeJS used

# IPC for Electron: System Info

Allow the renderer to get information about the version of Electron, Chrome and NodeJS

NPM link: [@el3um4s/ipc-for-electron-system-info](https://www.npmjs.com/package/@el3um4s/ipc-for-electron-system-info)

Use [@el3um4s/ipc-for-electron](https://www.npmjs.com/package/@el3um4s/ipc-for-electron) and [@el3um4s/renderer-for-electron-system-info](https://www.npmjs.com/package/@el3um4s/renderer-for-electron-system-info) to allow communication between Electron and a web page

### Install and use the package

To use the package in a project:

```bash
npm i @el3um4s/ipc-for-electron @el3um4s/ipc-for-electron-system-info @el3um4s/renderer-for-electron-system-info
```

Then the `preload.ts` file:

```ts
import { generateContextBridge } from "@el3um4s/ipc-for-electron";
import systemInfo from "@el3um4s/ipc-for-electron-system-info";

const listAPI = [systemInfo];

generateContextBridge(listAPI);
```

In the renderer file:

```ts
import systemInfo from "@el3um4s/renderer-for-electron-system-info";
let isWindows = false;

systemInfo.requestIsWindows({
  callback: (data) => {
    isWindows = data.isWindows;
  },
});

let app: string = "-";
let chrome: string = "-";
let node: string = "-";
let electron: string = "-";

systemInfo.requestSystemInfo({
  callback: (data) => {
    chrome = data.chrome;
    node = data.node;
    electron = data.electron;
    app = data.app;
  },
});
```

In the renderer you can use:

```ts
let isWindows = false;

globalThis.api.systemInfo.send("requestIsWindows", null);
globalThis.api.systemInfo.receive("getIsWindows", (data) => {
  isWindows = data.isWindows;
});

let chrome: string = "-";
let node: string = "-";
let electron: string = "-";
let app: string = "-";

globalThis.api.systemInfo.send("requestSystemInfo", null);
globalThis.api.systemInfo.receive("getSystemInfo", (data) => {
  chrome = data.chrome;
  node = data.node;
  electron = data.electron;
  app = data.app;
});
```

### API: Electron Side

- `requestSystemInfo` - Request the version of Electron, Chrome and NodeJS. The response is sent to the `getSystemInfo` channel
- `requestIsWindows` - Request if the OS is Windows. The response is sent to the `getIsWindows` channel

### API: Renderer Side - Request

`requestSystemInfo = async (options: { callback?: (arg0: SystemInfo) => void; apiKey?: string; }): Promise<SystemInfo>`

example:

```ts
import systemInfo from "@el3um4s/renderer-for-electron-system-info";

let app: string = "-";
let chrome: string = "-";
let node: string = "-";
let electron: string = "-";

systemInfo.requestSystemInfo({
  apiKey: "ipc",
  callback: (data) => {
    console.log("DATA OK", data);
    chrome = data.chrome;
    node = data.node;
    electron = data.electron;
    app = data.app;
  },
});
```

`requestIsWindows = async (options: { callback?: (arg0: IsWindows) => void; apiKey?: string; }): Promise<IsWindows>`

example:

```ts
import systemInfo from "@el3um4s/renderer-for-electron-system-info";

let isWindows = false;

systemInfo.requestIsWindows({
  apiKey: "ipc",
  callback: (data) => {
    console.log("DATA OK", data);
    isWindows = data.isWindows;
  },
});
```

### API: Renderer Side - Response

`on.getSystemInfo = async (options: { callback?: (arg0: SystemInfo) => void; apiKey?: string; }): Promise<SystemInfo>`

example:

```ts
import systemInfo from "@el3um4s/renderer-for-electron-system-info";

let app: string = "-";
let chrome: string = "-";
let node: string = "-";
let electron: string = "-";
systemInfo.requestSystemInfo();

systemInfo.on.getSystemInfo({
  apiKey: "ipc",
  callback: (data) => {
    console.log("DATA OK", data);
    chrome = data.chrome;
    node = data.node;
    electron = data.electron;
    app = data.app;
  },
});
```

`on.getIsWindows = async (options: { callback?: (arg0: IsWindows) => void; apiKey?: string; }): Promise<IsWindows>`

example:

```ts
import systemInfo from "@el3um4s/renderer-for-electron-system-info";

let isWindows = false;

systemInfo.requestIsWindows();

systemInfo.on.getIsWindows({
  apiKey: "ipc",
  callback: (data) => {
    console.log("DATA OK", data);
    isWindows = data.isWindows;
  },
});
```

### Types

**SystemInfo**

```ts
interface SystemInfo {
  chrome: string;
  node: string;
  electron: string;
  app: string;
}
```

**IsWindows**

```ts
interface IsWindows {
  isWindows: boolean;
}
```

**DefaultApiKey**

```ts
type DefaultApiKey = "ipc";
```