API index and search · Build metadata

Supporting declarations

packages/cli/src/platform.ts. These declarations explain referenced types. Only package-page symbols are package exports.

Exact source

export type Libc = "gnu" | "musl";

/** A native binary shipped by the Rindle development toolchain. */
export type Binary = "rindle" | "rindled" | "rindle-replicator" | "rindle-dev-edge";

/**
 * The package-name suffix identifying a build target for the current (or given) host:
 * `darwin-{arm64,x64}`, `linux-{x64,arm64}-{gnu,musl}`, `win32-x64-msvc`. Throws
 * `UnsupportedPlatformError` for a host we don't publish binaries for.
 */
export declare function platformKey(platform?: NodeJS.Platform, arch?: string, libc?: Libc): string;

/** The npm package name carrying the binaries for `key` (default: the current host's key). */
export declare function platformPackageName(key?: string): string;

/** The on-disk filename of `bin` inside a platform package (`rindle` / `rindled.exe`). */
export declare function binaryName(bin: Binary, platform?: NodeJS.Platform): string;

export declare class UnsupportedPlatformError extends Error {
    constructor(platform: string, arch: string);
}