retro-imager/dependencies/drivelist/lib/index.ts
2020-03-04 16:55:40 +01:00

85 lines
1.9 KiB
TypeScript

/*
* Copyright 2016 Balena.io
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @module drivelist
*/
import bindings = require('bindings');
import { platform } from 'os';
import { lsblk } from './lsblk';
export interface Mountpoint {
path: string;
label: string | null;
}
export interface Drive {
blockSize: number;
busType: string;
busVersion: null;
description: string;
device: string;
devicePath: string | null;
enumerator: string;
error: null;
isCard: null;
isReadOnly: boolean;
isRemovable: boolean;
isSCSI: boolean | null;
isSystem: boolean;
isUAS: null;
isUSB: boolean | null;
isVirtual: boolean | null;
logicalBlockSize: number;
mountpoints: Mountpoint[];
raw: string;
size: number | null;
}
/**
* @summary List available drives
* @function
* @public
*
* @returns {Promise} <Drive>[]
*
* @example
* const drivelist = require('drivelist');
*
* const drives = await drivelist.list();
* drives.forEach((drive) => {
* console.log(drive);
* });
*/
export async function list(): Promise<Drive[]> {
const plat = platform();
if (plat === 'win32' || plat === 'darwin') {
return new Promise((resolve, reject) => {
bindings('drivelist').list((error: Error, drives: Drive[]) => {
if (error != null) {
reject(error);
} else {
resolve(drives);
}
});
});
} else if (plat === 'linux') {
return await lsblk();
}
throw new Error(`Your OS is not supported by this module: ${platform()}`);
}