path-to-prop 2.0.2 → 2.0.4

package/README.md

@@ -17,21 +17,29 @@ Retrieves a property from an object based on a `'path/to.that.prop'`
 ```js
 import { getProp } from 'path-to-prop'
 
-const target = {a: {b: {c: {d: {e: 1}}}}}
+getProp({ nested: { prop: 1 } }, 'nested.prop') // 1
+
+getProp({ nested: { prop: 1 } }, 'nested') // { prop: 1 }
+```
+
+You can use `/` or `.` to access nested props:
+
+```js
+const obj = {a: {b: {c: {d: {e: 1}}}}}
 const path = 'a/b/c.d.e'
 
-getProp(target, path)
+getProp(obj, path)
   // returns 1
 
-getProp(target, 'nonexistent.prop')
+getProp(obj, 'nonexistent.prop')
   // returns undefined
 ```
 
 When you have `/` or `.` in your prop names, use an array:
 
 ```js
-const target = {'a/b': {'c.d': 1}}
+const obj = {'a/b': {'c.d': 1}}
 
-getProp(target, ['a/b', 'c.d'])
+getProp(obj, ['a/b', 'c.d'])
   // returns 1
 ```

package/dist/cjs/index.cjs

@@ -0,0 +1,18 @@
+'use strict';
+
+function getKeysFromPath(path) {
+  return path.split ? path.split(/\.|\//) : path;
+}
+function pathToProp(obj, path) {
+  const keys = getKeysFromPath(path);
+  let p;
+  for (p = 0; p < keys.length; p++) {
+    obj = obj ? obj[keys[p]] : void 0;
+  }
+  return obj === void 0 ? void 0 : obj;
+}
+const getProp = pathToProp;
+
+exports.getKeysFromPath = getKeysFromPath;
+exports.getProp = getProp;
+exports.pathToProp = pathToProp;

package/dist/{index.es.js → cjs/index.d.cts}

@@ -1,27 +1,18 @@
-/**
- * Returns the keys of a path
- *
- * @param   {string} path   a/path/like.this
- * @returns {string[]} with keys
- */
-function getKeysFromPath(path) {
-    return path.split ? path.split(/\.|\//) : path;
-}
-/**
- * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
- *
- * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
- * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
- * @returns {unknown} the last prop in the path
- */
-function pathToProp(obj, path) {
-    const keys = getKeysFromPath(path);
-    let p;
-    for (p = 0; p < keys.length; p++) {
-        obj = (obj ? obj[keys[p]] : undefined);
-    }
-    return obj === undefined ? undefined : obj;
-}
-const getProp = pathToProp;
+/**
+ * Returns the keys of a path
+ *
+ * @param   {string} path   a/path/like.this
+ * @returns {string[]} with keys
+ */
+declare function getKeysFromPath(path: string | string[]): string[];
+/**
+ * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
+ *
+ * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
+ * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
+ * @returns {unknown} the last prop in the path
+ */
+declare function pathToProp(obj: Record<string, unknown>, path: string | string[]): unknown;
+declare const getProp: typeof pathToProp;
 
 export { getKeysFromPath, getProp, pathToProp };

package/dist/{types/index.d.ts → index.d.ts}

@@ -1,16 +1,18 @@
-/**
- * Returns the keys of a path
- *
- * @param   {string} path   a/path/like.this
- * @returns {string[]} with keys
- */
-export declare function getKeysFromPath(path: string | string[]): string[];
-/**
- * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
- *
- * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
- * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
- * @returns {unknown} the last prop in the path
- */
-export declare function pathToProp(obj: Record<string, unknown>, path: string | string[]): unknown;
-export declare const getProp: typeof pathToProp;
+/**
+ * Returns the keys of a path
+ *
+ * @param   {string} path   a/path/like.this
+ * @returns {string[]} with keys
+ */
+declare function getKeysFromPath(path: string | string[]): string[];
+/**
+ * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
+ *
+ * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
+ * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
+ * @returns {unknown} the last prop in the path
+ */
+declare function pathToProp(obj: Record<string, unknown>, path: string | string[]): unknown;
+declare const getProp: typeof pathToProp;
+
+export { getKeysFromPath, getProp, pathToProp };

package/dist/index.js

@@ -0,0 +1,14 @@
+function getKeysFromPath(path) {
+  return path.split ? path.split(/\.|\//) : path;
+}
+function pathToProp(obj, path) {
+  const keys = getKeysFromPath(path);
+  let p;
+  for (p = 0; p < keys.length; p++) {
+    obj = obj ? obj[keys[p]] : void 0;
+  }
+  return obj === void 0 ? void 0 : obj;
+}
+const getProp = pathToProp;
+
+export { getKeysFromPath, getProp, pathToProp };

package/package.json

@@ -1,17 +1,22 @@
 {
   "name": "path-to-prop",
-  "version": "2.0.2",
-  "sideEffects": false,
-  "type": "module",
+  "version": "2.0.4",
   "description": "Retrieves a property from an object based on a 'path/to.that.prop'",
-  "module": "./dist/index.es.js",
-  "main": "./dist/index.cjs",
-  "types": "./dist/types/index.d.ts",
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "main": "./dist/index.js",
   "exports": {
     ".": {
-      "import": "./dist/index.es.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/types/index.d.ts"
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     }
   },
   "files": [
@@ -23,7 +28,7 @@
   "scripts": {
     "test": "vitest run",
     "lint": "tsc --noEmit && eslint ./src --ext .ts",
-    "build": "rollup -c ./scripts/build.js",
+    "build": "rollup -c ./rollup.config.js",
     "release": "npm run lint && del dist && npm run build && np"
   },
   "keywords": [
@@ -45,18 +50,19 @@
   "license": "MIT",
   "homepage": "https://github.com/mesqueeb/path-to-prop#readme",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.10.1",
-    "@typescript-eslint/parser": "^5.10.1",
-    "del-cli": "^4.0.1",
-    "eslint": "^8.7.0",
-    "eslint-config-prettier": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.2",
+    "@typescript-eslint/parser": "^5.59.2",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-tree-shaking": "^1.10.0",
-    "np": "^7.6.0",
-    "prettier": "^2.5.1",
-    "rollup": "^2.66.1",
-    "rollup-plugin-typescript2": "^0.31.1",
-    "typescript": "^4.5.5",
-    "vitest": "^0.2.3"
+    "np": "^7.7.0",
+    "prettier": "^2.8.8",
+    "rollup": "^3.23.0",
+    "rollup-plugin-dts": "^5.3.0",
+    "rollup-plugin-esbuild": "^5.0.0",
+    "typescript": "^4.9.5",
+    "vitest": "^0.31.0"
   },
   "bugs": {
     "url": "https://github.com/mesqueeb/path-to-prop/issues"

package/dist/index.cjs

@@ -1,33 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-/**
- * Returns the keys of a path
- *
- * @param   {string} path   a/path/like.this
- * @returns {string[]} with keys
- */
-function getKeysFromPath(path) {
-    return path.split ? path.split(/\.|\//) : path;
-}
-/**
- * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
- *
- * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
- * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
- * @returns {unknown} the last prop in the path
- */
-function pathToProp(obj, path) {
-    const keys = getKeysFromPath(path);
-    let p;
-    for (p = 0; p < keys.length; p++) {
-        obj = (obj ? obj[keys[p]] : undefined);
-    }
-    return obj === undefined ? undefined : obj;
-}
-const getProp = pathToProp;
-
-exports.getKeysFromPath = getKeysFromPath;
-exports.getProp = getProp;
-exports.pathToProp = pathToProp;