acore-js-os v1.2.0

Operating System API

The Operating System API is a TypeScript library that provides utility classes and interfaces for working with various operating system types. It allows you to retrieve information about different operating systems and register custom operating system implementations.

Table of Contents

• Introduction
• Installation
• Usage
• API Documentation

Introduction

The Operating System API simplifies the process of identifying and working with different operating systems in TypeScript projects. It offers a set of classes and interfaces that allow you to retrieve the name and key identifier of various operating systems, as well as register custom implementations.

Installation

To install the Operating System API, you can use npm:

npm install operating-system-api

Usage

Retrieving Operating System Information

import { OperatingSystemAPI, IOSType } from 'operating-system-api';

// Resolve the current operating system
const currentOS: IOSType = OperatingSystemAPI.resolveCurrent();

console.log('OS Name:', currentOS.getOSName());
console.log('OS Key:', currentOS.getOSKey());

Registering Custom Operating System Implementations

import { OperatingSystemAPI, IOSType } from 'operating-system-api';

class CustomOS implements IOSType {
    getOSKey(): string {
        return 'custom';
    }

    getOSName(): string {
        return 'Custom OS';
    }
}

// Register the custom operating system implementation
OperatingSystemAPI.register(new CustomOS());

const customOS: IOSType | undefined = OperatingSystemAPI.resolve('custom');
if (customOS) {
    console.log('Custom OS Name:', customOS.getOSName());
    console.log('Custom OS Key:', customOS.getOSKey());
}

API Documentation

Interfaces

IOSType

• getOSName(): string: Returns the name of the operating system.
• getOSKey(): string: Returns the key identifier of the operating system.

Classes

OperatingSystemAPI

• register(os: IOSType): void: Registers a custom operating system implementation.
• resolveCurrent(): IOSType: Resolves the current operating system.
• resolve(cOsName: string): IOSType | undefined: Resolves an operating system by its key identifier.

Operating System Implementations

• Linux: Provides methods to retrieve information about the Linux operating system.
• Macos: Provides methods to retrieve information about the MacOS operating system.
• Windows: Provides methods to retrieve information about the Windows operating system.