1.1.3 • Published 7 months ago

@types/find-duplicated-property-keys v1.1.3

Weekly downloads
13
License
MIT
Repository
github
Last release
7 months ago

Installation

npm install --save @types/find-duplicated-property-keys

Summary

This package contains type definitions for find-duplicated-property-keys (https://github.com/SebastianG77/find-duplicated-property-keys#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/find-duplicated-property-keys.

index.d.ts

// Type definitions for find-duplicated-property-keys 1.1
// Project: https://github.com/SebastianG77/find-duplicated-property-keys#readme
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * A package for detecting all duplicated property keys of a JSON string.
 * It can either be used as a standalone tool for validating JSON files or as a submodule for other Node.js projects.
 */
declare function findDuplicatedPropertyKeys(content: string): findDuplicatedPropertyKeys.PropertyInfo[];

declare namespace findDuplicatedPropertyKeys {
    interface PropertyInfo {
        /**
         *  The key name of the duplicated property
         */
        key: string;

        /**
         * The parent object of a property key
         */
        parent: PropertyInfo;

        /**
         * The number of property keys having the same key and parent object
         */

        occurrence: number;

        /**
         * Returns a list of property keys, which represents the path to the property key of the current object.
         */
        propertyPath(): string[];

        /**
         * Prints the path to the property key. However, since all necessary raw data are also contained by the object,
         * the result objects can also be represented in any other way if desired.
         */
        toString(): string;
    }
}

export = findDuplicatedPropertyKeys;

Additional Details

  • Last updated: Wed, 01 Dec 2021 21:01:07 GMT
  • Dependencies: none
  • Global values: none

Credits

These definitions were written by Piotr Błażejewicz.