npm-config-info/index.d.ts

An easy way to get npm user details or default values stored by npm.

/**
 * Compile the data available from npm config and returns a promise. (Async)
 * @param {boolean} includeGlobal Include the building of globals object.
 * @returns {Promise<ConfigInfo>}
 */
export function getConfig(includeGlobal: boolean): Promise<ConfigInfo>;
/**
 * Compile the data availabe from npm config and returns the object.
 * @param {boolean} includeGlobal Include the building of global object.
 * @returns {ConfigInfo}
 */
export function getConfigSync(includeGlobal: boolean): ConfigInfo;

/**
 * A Config Object
 */
declare class ConfigInfo {
    /**
     * Construct the ConfigInfo object.
     * @param {string|Buffer} data Data that needs to be parsed.
     * @param {boolean} [includeGlobal] If the global variables should be created at construction time.
     * @constructor
     */
    constructor(data: string | Buffer, includeGlobal?: boolean);
    /**
     * All the information to get from the current data object.  There may be more OR less properties availaable
     */
    config: configObject;
    /**
     * Get all the relevant folders.
     * */
    folders: folderInformation;
    /**
     * Get only the author related details.  If no author details is stored, will also look at user variables.
     */
    author: authorInformation;
    /**
     * Get the the init default values which is stored by means of npm set init-author-name etc.
     */
    init: initObject;
    /**
     * Return the current state of the global Config object
     */
    globalState: globState;
    /**
     * The general placeholder of the global npmrc file data.  Or string:
     * - "getGlobal function not yet called" is displayed if getGlobal has not yet been called.
     * - can't find config is displayed if we can't find the npmrc file.
     */
    global: ConfigInfo | string;
    /**
     * Updates the global variable.
     * @param {string} [configFile] An optional location to the global config file.
     * @returns {boolean} True if a global object was created, else false.
     */
    getGlobal(configFile?: string): boolean;
    /**
     * Determine if a global npmrc file exist (according to the standard searches).
     */
    globalExist: boolean;
}

/**
 * The available states for the global object.
 */
export enum globState {
    /** The global object has not yet been initialized. */
    NotInitialized,
    /** The global file could not be found. */
    NotFound,
    /** The global object has been initialized. */
    Initialized
}
/**
 * General structure of a data object that we receive.
 */
declare type configObject = {
    long?: boolean;
    'metrics-registry'?: string;
    scope?: number;
    'user-agent'?: string;
    'init-author-email'?: string;
    'init-author-name'?: string;
    'init-author-url'?: string;
    'init-license'?: string;
    'init-version'?: string;
    prefix?: string;
    'always-auth'?: boolean;
    audit?: boolean;
    'audit-level'?: string;
    'auth-type'?: string;
    'bin-links'?: boolean;
    browser?: string;
    ca?: string;
    cache?: string;
    'cache-lock-retries'?: number;
    'cache-lock-stale'?: number;
    'cache-lock-wait'?: number;
    'cache-max'?: number;
    'cache-min'?: number;
    cafile?: string;
    cert?: string;
    cidr?: string;
    color?: boolean;
    'commit-hooks'?: boolean; description?: boolean;
    dev?: boolean;
    'dry-run'?: boolean;
    editor?: string;
    'engine-strict'?: boolean;
    'fetch-retries'?: number;
    'fetch-retry-factor'?: number;
    'fetch-retry-maxtimeout'?: number;
    'fetch-retry-mintimeout'?: number;
    force?: boolean;
    'format-package-lock'?: boolean;
    git?: string;
    'git-tag-version'?: boolean;
    global?: boolean;
    'global-style'?: boolean;
    globalconfig?: string;
    globalignorefile?: string;
    group?: number;
    'ham-it-up'?: boolean;
    heading?: string;
    'https-proxy'?: any;
    'if-present'?: boolean;
    'ignore-prepublish'?: boolean;
    'ignore-scripts'?: boolean;
    'init-module'?: string;
    json?: boolean;
    key?: any;
    'legacy-bundling'?: boolean;
    link?: boolean;
    'local-address'?: undefined;
    loglevel?: string;
    'logs-max'?: number;
    maxsockets?: number;
    message?: string;
    'node-options'?: any;
    'node-version'?: string;
    noproxy?: any;
    offline?: boolean;
    'onload-script'?: any;
    only?: any;
    optional?: boolean;
    otp?: any;
    'package-lock'?: boolean;
    'package-lock-only'?: boolean;
    parseable?: boolean;
    'prefer-offline'?: boolean;
    'prefer-online'?: boolean;
    preid?: number;
    production?: boolean;
    progress?: boolean;
    proxy?: any;
    'read-only'?: boolean;
    'rebuild-bundle'?: boolean;
    registry?: string;
    rollback?: boolean;
    save?: boolean;
    'save-bundle'?: boolean;
    'save-dev'?: boolean;
    'save-exact'?: boolean;
    'save-optional'?: boolean;
    'save-prefix'?: string;
    'save-prod'?: boolean;
    'script-shell'?: any;
    'scripts-prepend-node-path'?: string;
    searchexclude?: any;
    searchlimit?: number;
    searchopts?: number;
    searchstaleness?: number;
    'send-metrics'?: boolean;
    shell?: string;
    shrinkwrap?: boolean;
    'sign-git-commit'?: boolean;
    'sign-git-tag'?: boolean;
    'sso-poll-frequency'?: number;
    'sso-type'?: string;
    'strict-ssl'?: boolean;
    tag?: string;
    'tag-version-prefix'?: string;
    timing?: boolean;
    tmp?: string;
    umask?: number;
    unicode?: boolean;
    'unsafe-perm'?: boolean;
    'update-notifier'?: boolean;
    usage?: boolean;
    user?: string;
    userconfig?: string;
    version?: boolean;
    versions?: boolean;
    viewer?: string;
    tmpuserconfig?: string;
    tmpglobalconfig?: string;
    [key: string]: any;
}

/**
 * Contains the information related to the author (alternatively user)
 */
declare type authorInformation = {
    name?: string;
    email?: string;
    url?: string;
    value?: string;
}
/**
 * Contains all the relevant folder information
 */
declare type folderInformation = {
    userconfig?: string;
    tmp?: string;
    shell?: string;
    initModule?: string;
    globalignorefile?: string;
    globalconfig?: string;
    cache?: string;
    prefix?: string;
    'metrics-registry'?: string;
    tmpuserconfig?: string;
    tmpglobalconfig?: string;
}
/**
 * Contains all the values that has been stored with the init- prefix.
 */
declare type initObject = {
    version?: string;
    descriptsion?: string;
    main?: string;
    test?: string;
    git?: string;
    author?: string;
    license?: string;
}