1. module dot-prop
   1. function dot-prop.delete (obj, path)
   2. function dot-prop.get (obj, path, value)
   3. function dot-prop.has (obj, path)
   4. function dot-prop.set (obj, path, value)
   5. object dot-prop.index
2. module dot-prop.index
   1. function dot-prop.index.delete (obj, path)
   2. function dot-prop.index.get (obj, path, value)
   3. function dot-prop.index.has (obj, path)
   4. function dot-prop.index.set (obj, path, value)

module dot-prop

function dot-prop.delete (obj, path)

• description and source-code

  delete(obj, path) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			const p = pathArr[i];
  
  			if (i === pathArr.length - 1) {
  				delete obj[p];
  				return;
  			}
  
  			obj = obj[p];
  
  			if (!isObj(obj)) {
  				return;
  			}
  		}
  	}

• example usage

  ...
  
  // has
  dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar');
  //=> true
  
  // deleter
  const obj = {foo: {bar: 'a'}};
  dotProp.delete(obj, 'foo.bar');
  console.log(obj);
  //=> {foo: {}}
  
  obj.foo.bar = {x: 'y', y: 'x'};
  dotProp.delete(obj, 'foo.bar.x');
  console.log(obj);
  //=> {foo: {bar: {y: 'x'}}}
  ...

function dot-prop.get (obj, path, value)

• description and source-code

  get(obj, path, value) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return value === undefined ? obj : value;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			if (!Object.prototype.propertyIsEnumerable.call(obj, pathArr[i])) {
  				return value;
  			}
  
  			obj = obj[pathArr[i]];
  
  			if (obj === undefined || obj === null) {
  				// `obj` is either `undefined` or `null` so we want to stop the loop, and
  				// if this is not the last bit of the path, and
  				// if it did't return `undefined`
  				// it would return `null` if `obj` is `null`
  				// but we want `get({foo: null}, 'foo.bar')` to equal `undefined`, or the supplied value, not `null`
  				if (i !== pathArr.length - 1) {
  					return value;
  				}
  
  				break;
  			}
  		}
  
  		return obj;
  	}

• example usage

  ...
  
  ## Usage
  
  ```js
  const dotProp = require('dot-prop');
  
  // getter
  dotProp.get({foo: {bar: 'unicorn'}}, 'foo.bar');
  //=> 'unicorn'
  
  dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep');
  //=> undefined
  
  dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value');
  //=> 'default value'
  ...

function dot-prop.has (obj, path)

• description and source-code

  has(obj, path) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return false;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			if (isObj(obj)) {
  				if (!(pathArr[i] in obj)) {
  					return false;
  				}
  
  				obj = obj[pathArr[i]];
  			} else {
  				return false;
  			}
  		}
  
  		return true;
  	}

• example usage

  ...
  //=> {foo: {bar: 'b'}}
  
  dotProp.set(obj, 'foo.baz', 'x');
  console.log(obj);
  //=> {foo: {bar: 'b', baz: 'x'}}
  
  // has
  dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar');
  //=> true
  
  // deleter
  const obj = {foo: {bar: 'a'}};
  dotProp.delete(obj, 'foo.bar');
  console.log(obj);
  //=> {foo: {}}
  ...

function dot-prop.set (obj, path, value)

• description and source-code

  set(obj, path, value) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			const p = pathArr[i];
  
  			if (!isObj(obj[p])) {
  				obj[p] = {};
  			}
  
  			if (i === pathArr.length - 1) {
  				obj[p] = value;
  			}
  
  			obj = obj[p];
  		}
  	}

• example usage

  ...
  //=> 'default value'
  
  dotProp.get({foo: {'dot.dot': 'unicorn'}}, 'foo.dot\\.dot');
  //=> 'unicorn'
  
  // setter
  const obj = {foo: {bar: 'a'}};
  dotProp.set(obj, 'foo.bar', 'b');
  console.log(obj);
  //=> {foo: {bar: 'b'}}
  
  dotProp.set(obj, 'foo.baz', 'x');
  console.log(obj);
  //=> {foo: {bar: 'b', baz: 'x'}}
  ...

module dot-prop.index

function dot-prop.index.delete (obj, path)

• description and source-code

  delete(obj, path) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			const p = pathArr[i];
  
  			if (i === pathArr.length - 1) {
  				delete obj[p];
  				return;
  			}
  
  			obj = obj[p];
  
  			if (!isObj(obj)) {
  				return;
  			}
  		}
  	}

• example usage

  ...
  
  // has
  dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar');
  //=> true
  
  // deleter
  const obj = {foo: {bar: 'a'}};
  dotProp.delete(obj, 'foo.bar');
  console.log(obj);
  //=> {foo: {}}
  
  obj.foo.bar = {x: 'y', y: 'x'};
  dotProp.delete(obj, 'foo.bar.x');
  console.log(obj);
  //=> {foo: {bar: {y: 'x'}}}
  ...

function dot-prop.index.get (obj, path, value)

• description and source-code

  get(obj, path, value) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return value === undefined ? obj : value;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			if (!Object.prototype.propertyIsEnumerable.call(obj, pathArr[i])) {
  				return value;
  			}
  
  			obj = obj[pathArr[i]];
  
  			if (obj === undefined || obj === null) {
  				// `obj` is either `undefined` or `null` so we want to stop the loop, and
  				// if this is not the last bit of the path, and
  				// if it did't return `undefined`
  				// it would return `null` if `obj` is `null`
  				// but we want `get({foo: null}, 'foo.bar')` to equal `undefined`, or the supplied value, not `null`
  				if (i !== pathArr.length - 1) {
  					return value;
  				}
  
  				break;
  			}
  		}
  
  		return obj;
  	}

• example usage

  ...
  
  ## Usage
  
  ```js
  const dotProp = require('dot-prop');
  
  // getter
  dotProp.get({foo: {bar: 'unicorn'}}, 'foo.bar');
  //=> 'unicorn'
  
  dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep');
  //=> undefined
  
  dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value');
  //=> 'default value'
  ...

function dot-prop.index.has (obj, path)

• description and source-code

  has(obj, path) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return false;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			if (isObj(obj)) {
  				if (!(pathArr[i] in obj)) {
  					return false;
  				}
  
  				obj = obj[pathArr[i]];
  			} else {
  				return false;
  			}
  		}
  
  		return true;
  	}

• example usage

  ...
  //=> {foo: {bar: 'b'}}
  
  dotProp.set(obj, 'foo.baz', 'x');
  console.log(obj);
  //=> {foo: {bar: 'b', baz: 'x'}}
  
  // has
  dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar');
  //=> true
  
  // deleter
  const obj = {foo: {bar: 'a'}};
  dotProp.delete(obj, 'foo.bar');
  console.log(obj);
  //=> {foo: {}}
  ...

function dot-prop.index.set (obj, path, value)

• description and source-code

  set(obj, path, value) {
  		if (!isObj(obj) || typeof path !== 'string') {
  			return;
  		}
  
  		const pathArr = getPathSegments(path);
  
  		for (let i = 0; i < pathArr.length; i++) {
  			const p = pathArr[i];
  
  			if (!isObj(obj[p])) {
  				obj[p] = {};
  			}
  
  			if (i === pathArr.length - 1) {
  				obj[p] = value;
  			}
  
  			obj = obj[p];
  		}
  	}

• example usage

  ...
  //=> 'default value'
  
  dotProp.get({foo: {'dot.dot': 'unicorn'}}, 'foo.dot\\.dot');
  //=> 'unicorn'
  
  // setter
  const obj = {foo: {bar: 'a'}};
  dotProp.set(obj, 'foo.bar', 'b');
  console.log(obj);
  //=> {foo: {bar: 'b'}}
  
  dotProp.set(obj, 'foo.baz', 'x');
  console.log(obj);
  //=> {foo: {bar: 'b', baz: 'x'}}
  ...