gatsby-core-utils
Version:
A collection of gatsby utils used in different gatsby packages
44 lines (42 loc) • 1.59 kB
JavaScript
import { getPhysicalCpuCount } from "./physical-cpu-count";
/**
* Calculate CPU core count
*
* @param ignoreEnvVar Ignore the 'GATSBY_CPU_COUNT' env var to calculate the requested type of CPU cores
* @return Count of the requested type of CPU cores. Defaults to number of physical cores or 1
*/
export const cpuCoreCount = ignoreEnvVar => {
try {
let coreCount = getPhysicalCpuCount() || 1;
if (ignoreEnvVar) {
// Return the physical CPU count,
// or default to 1 if we can't detect
return coreCount;
}
if (typeof process.env.GATSBY_CPU_COUNT !== `undefined`) {
const coreCountArg = Number(process.env.GATSBY_CPU_COUNT) || process.env.GATSBY_CPU_COUNT;
switch (typeof coreCountArg) {
case `string`:
// Leave at Default CPU count if coreCountArg === `physical_cores`
// CPU count === logical CPU count
// throw error if we have a problem counting logical cores
if (coreCountArg === `logical_cores`) {
coreCount = require(`os`).cpus().length;
if (typeof coreCount !== `number`) {
throw new Error(`process.env.GATSBY_CPU_COUNT is set to 'logical_cores' but there was a problem finding the number of logical cores`);
}
}
break;
case `number`:
// CPU count === passed in count
coreCount = coreCountArg;
break;
default:
break;
}
}
return coreCount;
} catch (err) {
throw new Error(`There has been a problem counting the number of CPU cores`);
}
};