Socket
Socket
Sign inDemoInstall

detect-libc

Package Overview
Dependencies
0
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

detect-libc

Node.js module to detect the C standard library (libc) implementation family and version

    2.0.2latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
15,059,620
increased by5.15%

Weekly downloads

Package description

What is detect-libc?

The detect-libc npm package is a simple utility for detecting the C standard library version on a system. It is primarily used in node-gyp and prebuild-install to ensure binary compatibility with the host system's libc when compiling native addons.

What are detect-libc's main functionalities?

Detecting the system's C library

This feature allows you to detect the C library family (e.g., glibc, musl) and version used by the system. This is useful for determining binary compatibility for native modules.

const detectLibc = require('detect-libc');

const libcFamily = detectLibc.family;
const libcVersion = detectLibc.version;

console.log(`Libc Family: ${libcFamily}`);
console.log(`Libc Version: ${libcVersion}`);

Checking if the system uses a specific C library

This feature provides a boolean check to determine if the system is using a non-glibc C library, which can be important for certain build processes and compatibility checks.

const detectLibc = require('detect-libc');

if (detectLibc.isNonGlibcLinux) {
  console.log('The system uses a non-glibc C library.');
} else {
  console.log('The system uses glibc.');
}

Other packages similar to detect-libc

Readme

Source

detect-libc

Node.js module to detect details of the C standard library (libc) implementation provided by a given Linux system.

Currently supports detection of GNU glibc and MUSL libc.

Provides asychronous and synchronous functions for the family (e.g. glibc, musl) and version (e.g. 1.23, 1.2.3).

The version numbers of libc implementations are not guaranteed to be semver-compliant.

For previous v1.x releases, please see the v1 branch.

Install

npm install detect-libc

API

GLIBC

const GLIBC: string = 'glibc';

A String constant containing the value glibc.

MUSL

const MUSL: string = 'musl';

A String constant containing the value musl.

family

function family(): Promise<string | null>;

Resolves asychronously with:

  • glibc or musl when the libc family can be determined
  • null when the libc family cannot be determined
  • null when run on a non-Linux platform
const { family, GLIBC, MUSL } = require('detect-libc');

switch (await family()) {
  case GLIBC: ...
  case MUSL: ...
  case null: ...
}

familySync

function familySync(): string | null;

Synchronous version of family().

const { familySync, GLIBC, MUSL } = require('detect-libc');

switch (familySync()) {
  case GLIBC: ...
  case MUSL: ...
  case null: ...
}

version

function version(): Promise<string | null>;

Resolves asychronously with:

  • The version when it can be determined
  • null when the libc family cannot be determined
  • null when run on a non-Linux platform
const { version } = require('detect-libc');

const v = await version();
if (v) {
  const [major, minor, patch] = v.split('.');
}

versionSync

function versionSync(): string | null;

Synchronous version of version().

const { versionSync } = require('detect-libc');

const v = versionSync();
if (v) {
  const [major, minor, patch] = v.split('.');
}

isNonGlibcLinux

function isNonGlibcLinux(): Promise<boolean>;

Resolves asychronously with:

  • false when the libc family is glibc
  • true when the libc family is not glibc
  • false when run on a non-Linux platform
const { isNonGlibcLinux } = require('detect-libc');

if (await isNonGlibcLinux()) { ... }

isNonGlibcLinuxSync

function isNonGlibcLinuxSync(): boolean;

Synchronous version of isNonGlibcLinux().

const { isNonGlibcLinuxSync } = require('detect-libc');

if (isNonGlibcLinuxSync()) { ... }

Licensing

Copyright 2017 Lovell Fuller and others.

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.

Keywords

FAQs

Last updated on 18 Jul 2023

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc