@socketsecurity/lib/dist/env/github.d.ts

Core utilities and infrastructure for Socket.dev security tools

/**
 * GITHUB_API_URL environment variable.
 * GitHub API URL (e.g., https://api.github.com).
 */
export declare function getGithubApiUrl(): string | undefined;
/**
 * GITHUB_BASE_REF environment variable.
 * GitHub pull request base branch.
 */
export declare function getGithubBaseRef(): string | undefined;
/**
 * GITHUB_REF_NAME environment variable.
 * GitHub branch or tag name.
 */
export declare function getGithubRefName(): string | undefined;
/**
 * GITHUB_REF_TYPE environment variable.
 * GitHub ref type (branch or tag).
 */
export declare function getGithubRefType(): string | undefined;
/**
 * GITHUB_REPOSITORY environment variable.
 * GitHub repository name in owner/repo format.
 */
export declare function getGithubRepository(): string | undefined;
/**
 * GITHUB_SERVER_URL environment variable.
 * GitHub server URL (e.g., https://github.com).
 */
export declare function getGithubServerUrl(): string | undefined;
/**
 * GITHUB_TOKEN environment variable.
 * GitHub authentication token for API access.
 */
export declare function getGithubToken(): string | undefined;
/**
 * GH_TOKEN environment variable.
 * Alternative GitHub authentication token for API access (used by GitHub CLI).
 */
export declare function getGhToken(): string | undefined;