JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 693760
  • Score
    100M100P100Q182762F
  • License MIT

TypeScript definitions for configstore

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/configstore) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Installation

    npm install --save @types/configstore

    Summary

    This package contains type definitions for configstore (https://github.com/yeoman/configstore).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/configstore.

    index.d.ts

    export default class Configstore {
        constructor(packageName: string, defaults?: any, options?: ConfigstoreOptions);
    
        /**
         * Get the path to the config file. Can be used to show the user
         * where it is, or better, open it for them.
         */
        path: string;
    
        /**
         * Get all items as an object or replace the current config with an object.
         */
        all: any;
    
        /**
         * Get the item count
         */
        size: number;
    
        /**
         * Get an item
         * @param key The string key to get
         * @return The contents of the config from key $key
         */
        get(key: string): any;
    
        /**
         * Set an item
         * @param key The string key
         * @param val The value to set
         */
        set(key: string, val: any): void;
    
        /**
         * Set all key/value pairs declared in $values
         * @param values The values object.
         */
        set(values: any): void;
    
        /**
         * Determines if a key is present in the config
         * @param key The string key to test for
         * @return True if the key is present
         */
        has(key: string): boolean;
    
        /**
         * Delete an item.
         * @param key The key to delete
         */
        delete(key: string): void;
    
        /**
         * Clear the config.
         * Equivalent to <code>Configstore.all = {};</code>
         */
        clear(): void;
    }
    
    export interface ConfigstoreOptions {
        globalConfigPath?: boolean | undefined;
        configPath?: string | undefined;
    }
    

    Additional Details

    • Last updated: Mon, 06 Nov 2023 22:41:05 GMT
    • Dependencies: none

    Credits

    These definitions were written by ArcticLight.