# object-access > Access(read, write and delete) an object by hierarchical keys. Latest version **2.0.4** (published 2018-08-12) · MIT license · 0 weekly downloads ## Install ```sh npm install object-access pnpm add object-access yarn add object-access bun add object-access ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.4 | | Published | 2018-08-12 | | First published | 2015-10-27 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10.0 | | Dependencies | 0 | | Unpacked size | 7.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | kaelzhang | | Maintainers | kael | | Keywords | object-access, object, set, get, remove, hierarchical, null, propagation, operator, null-propagation-operator, alternative | ## Links - npm: https://www.npmjs.com/package/object-access - Repository: https://github.com/kaelzhang/node-object-access - Homepage: https://github.com/kaelzhang/node-object-access#readme - Issues: https://github.com/kaelzhang/node-object-access/issues - npm.io page: https://npm.io/package/object-access ## Alternatives - [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads - [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads - [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads - [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads - [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads ## Recent versions - 2.0.4 (latest) — 2018-08-12 - 2.0.3 — 2018-08-12 - 2.0.2 — 2018-08-12 - 2.0.1 — 2018-06-20 - 2.0.0 — 2018-06-20 - 1.2.5 — 2018-01-17 - 1.2.4 — 2018-01-17 - 1.2.3 — 2018-01-17 - 1.2.2 — 2017-05-20 - 1.2.1 — 2017-05-10 - 1.2.0 — 2017-05-09 - 1.1.5 — 2017-05-09 - 1.1.4 — 2015-11-02 - 1.1.2 — 2015-11-02 - 1.1.1 — 2015-10-29 - … 5 more at https://npm.io/package/object-access/versions ## README [![Build Status](https://travis-ci.org/kaelzhang/node-object-access.svg?branch=master)](https://travis-ci.org/kaelzhang/node-object-access) # object-access Access(read, write and delete) an object by hierarchical keys. And it can be used as an alternative for the null propagation operator ## Synopsis ```js const access = require('object-access') const obj = { one: { two: 2 } } ``` If we use a null operator like many other languages and the [tc39 proposal](https://docs.google.com/presentation/d/11O_wIBBbZgE1bMVRJI8kGnmC6dWCBOwutbN9SWOK0fU/view#slide=id.g1c161255c9_0_55) ```js // Use Null Propagation Operator obj.one?.two // 2 // Use object-access access(obj, 'one.two', 2)) // 2 ``` ## Usage ```js // Get access(obj, 'one.two') // 2 access(obj, ['one', 'two']) // 2 access(obj, ['one', 'three']) // undefined access(obj, ['one', 'three', 'four']) // undefined access(obj, ['one', 'three', 'four'], 4) // 4 // Set access.set(obj, 'one.two', 3) // 3 // then obj.one.two.three is 3 access.set(obj, ['one', 'two'], 4) // 4 // then obj.one.two.three is 4 // If the subtle object is not found, it will create one access.set(obj, ['three', 'four'], 6) // 6 // then obj.three.four is 6 // If we try to set a property on a none-object value, it will thrown. access.set(obj, 'one.two.tree', 3) // Error thrown! // Force setting access.set(obj, 'one.two.tree', 3, true) // true // obj.one.two is {three: 3} access.delete(obj, 'one.two.four') // obj.one.two.four -> undefined access.delete(obj, 'one.two.tree') // obj.one.two -> {} access.delete(obj, 'one.two') // obj.one -> {} ``` ### access(obj, key_list [, default_value]) ### access.get(obj, key_list [, default_value]) Get value - obj `Object` - key_list `Array|string` see the example above - default_value `any=` if key_list not found, then returns the `default_value`, if `default_value` is not specified, `undefined` will be returned. ### access.set(obj, key_list, value [, force]) If the property already exists and is not an object, `access.set()` will throw an error whose `code` is `SET_ON_NONE_OBJECT`. If you want to force setting new values on none object value and override it, or to prevent any errors, use `force=true`. Returns `value` ### access.delete(obj, key_list) : boolean Removes a key by deleting it if exists. Returns `true` if succeeded otherwise `false` ### ~~access.remove(obj, key_list)~~ DEPRECATED in `1.2.0` ## Upgrade from `1.x` to `2.x` Method | `1.x` | `2.x` ---- | ---- | ---- set | no return value | has return value if there is no error set | never thrown | thrown if you try to set property on none object remove | no return value | has return value ## License MIT --- _Source: https://npm.io/package/object-access · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._