@types/json-pointer - npm Package Compare versions

Comparing version 1.0.30 to 1.0.31

json-pointer/index.d.ts

 // Type definitions for json-pointer 1.0
-// Project: https://www.npmjs.org/package/json-pointer
+// Project: https://github.com/manuelstofer/json-pointer
 // Definitions by: Bart van der Schoor <https://github.com/Bartvds>
+//                 BendingBender <https://github.com/BendingBender>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// Minimum TypeScript Version: 4.0
 
+export = JsonPointer;
 
-declare function JSON_Pointer(object: Object): JSON_Pointer.JSON_PointerWrap;
+declare const JsonPointer: JsonPointer.Wrapper & JsonPointer.Api;
 
-declare namespace JSON_Pointer {
-    /**
-     *  Wrap an object with accessors
-     */
-    /**
-     *  Looks up a JSON pointer in an object.
-     */
-    function get(object: Object, pointer: string): any;
-    /**
-     *  Set a value for a JSON pointer on object.
-     */
-    function set(object: Object, pointer: string, value: any): void;
-    /**
-     *  Removes an attribute of object referenced by pointer
-     */
-    function remove(object: Object, pointer: string): void;
-    /**
-     *  Creates a dictionary object (pointer -> value).
-     */
-    function dict(object: Object): Object;
-    /**
-     *  Just like: each(pointer.dict(obj), iterator);
-     */
-    function walk(object: Object, iterator: (value: any, key: string) => void): void;
-    /**
-     *  Tests if an object has a value for a JSON pointer.
-     */
-    function has(object: Object, pointer: string): boolean;
-    /**
-     *  Escapes a reference token.
-     */
-    function escape(str: string): string;
-    /**
-     *  Unescape a reference token.
-     */
-    function unescape(str: string): string;
-    /**
-     *  Converts a JSON pointer into an array of reference tokens.
-     */
-    function parse(str: string): string[];
-    /**
-     *  Builds a json pointer from an array of reference tokens.
-     */
-    function compile(str: string[]): string;
+declare namespace JsonPointer {
+    type JsonObject = Record<string | number, any> | any[];
 
-    interface JSON_PointerWrap {
+    interface Wrapper {
         /**
-         *  Looks up a JSON pointer in an object.
+         * Convenience wrapper around the api.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * const object = {
+         *     example: 'hello'
+         * };
+         *
+         * pointer(object);                      // bind object
+         * pointer(object, '/example');          // get
+         * pointer(object, '/example', 'world'); // set
+         *
+         * // The wrapper supports chainable object oriented style.
+         * const obj = { anything: 'bla' };
+         * const objPointer = pointer(obj);
+         * objPointer.set('/example', 'bla').dict();
          */
-        get(pointer: string): any;
+        (object: JsonObject): BoundWrapper & BoundApi;
+        (...args: Parameters<Api["get"]>): ReturnType<Api["get"]>;
+        (...args: Parameters<Api["set"]>): ReturnType<Api["set"]>;
+    }
+
+    interface BoundWrapper {
+        (pointer: string | string[]): any;
+        (pointer: string | string[], value: any): BoundApi;
+    }
+
+    interface Api {
         /**
-         *  Set a value for a JSON pointer on object.
+         * Looks up a JSON pointer in an object.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * const obj = {
+         *     example: {
+         *         bla: 'hello'
+         *     }
+         * };
+         * pointer.get(obj, '/example/bla');
+         * // -> 'hello'
          */
-        set(pointer: string, value: any): void;
+        get(object: JsonObject, pointer: string | string[]): any;
+
         /**
-         *  Removes an attribute of object referenced by pointer
+         * Sets a new value on object at the location described by pointer.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * const obj = {};
+         * pointer.set(obj, '/example/bla', 'hello');
+         * // obj -> { example: { bla: 'hello' } }
          */
-        remove(pointer: string): void;
+        set(object: JsonObject, pointer: string | string[], value: any): Api;
+
         /**
-         *  Creates a dictionary object (pointer -> value).
+         * Removes an attribute of object referenced by pointer.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * const obj = {
+         *     example: 'hello'
+         * };
+         * pointer.remove(obj, '/example');
+         * // obj -> {}
          */
-        dict(): Object;
+        remove(object: JsonObject, pointer: string | string[]): void;
+
         /**
-         *  Just like: each(pointer.dict(obj), iterator);
+         * Creates a dictionary object (pointer -> value).
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * const obj = {
+         *     hello: { bla: 'example' }
+         * };
+         * pointer.dict(obj);
+         * // -> { '/hello/bla': 'example' }
          */
-        walk(iterator: (value: any, key: string) => void): void;
+        dict(object: JsonObject, descend?: (value: any) => boolean): Record<string, any>;
+
         /**
-         *  Tests if an object has a value for a JSON pointer.
+         * Iterates over an object. Just like: `each(pointer.dict(obj), iterator);`.
          */
-        has(pointer: string): boolean;
+        walk(object: JsonObject, iterator: (value: any, ref: string) => void, descend?: (value: any) => boolean): void;
+
+        /**
+         * Tests if an object has a value for a JSON pointer.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * const obj = {
+         *     bla: 'hello'
+         * };
+         *
+         * pointer.has(obj, '/bla');          // -> true
+         * pointer.has(obj, '/non/existing'); // -> false
+         */
+        has(object: any, pointer: string | string[]): boolean;
+
+        /**
+         * Escapes a reference token.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * pointer.escape('hello~bla'); // -> 'hello~0bla'
+         * pointer.escape('hello/bla'); // -> 'hello~1bla'
+         */
+        escape(pointer: string): string;
+
+        /**
+         * Unescape a reference token.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * pointer.unescape('hello~0bla'); // -> 'hello~bla'
+         * pointer.unescape('hello~1bla'); // -> 'hello/bla'
+         */
+        unescape(pointer: string): string;
+
+        /**
+         * Converts a JSON pointer into an array of reference tokens.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * pointer.parse('/hello/bla'); // -> ['hello', 'bla']
+         */
+        parse(pointer: string): string[];
+
+        /**
+         * Builds a JSON pointer from an array of reference tokens.
+         *
+         * @example
+         * import pointer = require('json-pointer');
+         *
+         * pointer.compile(['hello', 'bla']); // -> '/hello/bla'
+         */
+        compile(tokens: string[]): string;
     }
+
+    type BoundApi = {
+        [key in "get" | "remove" | "dict" | "walk" | "has"]: (
+            ...params: DropFirst<Parameters<Api[key]>>
+        ) => ReturnType<Api[key]>;
+    } & {
+        set: (...params: DropFirst<Parameters<Api["set"]>>) => BoundApi;
+    };
 }
 
-export = JSON_Pointer;
+type DropFirst<T extends unknown[]> = T extends [any, ...infer U] ? U : never;

json-pointer/package.json

 {
     "name": "@types/json-pointer",
-    "version": "1.0.30",
+    "version": "1.0.31",
     "description": "TypeScript definitions for json-pointer",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-pointer",
     "license": "MIT",
-    "author": "Bart van der Schoor <https://github.com/Bartvds>",
+    "contributors": [
+        {
+            "name": "Bart van der Schoor",
+            "url": "https://github.com/Bartvds",
+            "githubUsername": "Bartvds"
+        },
+        {
+            "name": "BendingBender",
+            "url": "https://github.com/BendingBender",
+            "githubUsername": "BendingBender"
+        }
+    ],
     "main": "",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/json-pointer"
     },
     "scripts": {},
     "dependencies": {},
-    "peerDependencies": {},
-    "typesPublisherContentHash": "dc50fbad410581a644c40bd183cd7f267bac6cdcd0005377c139c6edff99a382",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "a64a865a3cc9290bf02cf8866eeda993599805f40f96db673e7da7cd0933ecaa",
+    "typeScriptVersion": "4.0"
 }

json-pointer/README.md

@@ -5,14 +5,13 @@ # Installation
 # Summary
-This package contains type definitions for json-pointer (https://www.npmjs.org/package/json-pointer).
+This package contains type definitions for json-pointer (https://github.com/manuelstofer/json-pointer).
 
 # Details
-Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/json-pointer
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-pointer.
 
-Additional Details
- * Last updated: Fri, 30 Dec 2016 00:00:11 GMT
- * Library Dependencies: none
- * Module Dependencies: none
+### Additional Details
+ * Last updated: Wed, 02 Jun 2021 21:01:34 GMT
+ * Dependencies: none
  * Global values: none
 
 # Credits
-These definitions were written by Bart van der Schoor <https://github.com/Bartvds>.
+These definitions were written by [Bart van der Schoor](https://github.com/Bartvds), and [BendingBender](https://github.com/BendingBender).

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8129

87.3%

Lines of code

157

60.2%

Number of low quality alerts

0

-100%

Worsened metrics

Number of lines in readme file

17

-5.56%

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes