set-getter

WebJar for set-getter

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

set-getter
Last Version

Last Version

0.1.0
Release Date

Release Date

Type

Type

jar
Description

Description

set-getter
WebJar for set-getter
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/doowb/set-getter

Download set-getter

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/set-getter/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>set-getter</artifactId>
    <version>0.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/set-getter/
implementation 'org.webjars.npm:set-getter:0.1.0'
// https://jarcasting.com/artifacts/org.webjars.npm/set-getter/
implementation ("org.webjars.npm:set-getter:0.1.0")
'org.webjars.npm:set-getter:jar:0.1.0'
<dependency org="org.webjars.npm" name="set-getter" rev="0.1.0">
  <artifact name="set-getter" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='set-getter', version='0.1.0')
)
libraryDependencies += "org.webjars.npm" % "set-getter" % "0.1.0"
[org.webjars.npm/set-getter "0.1.0"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : to-object-path jar [0.3.0,0.4)

Project Modules

There are no modules declared in this project.

set-getter NPM version NPM downloads Build Status

Create nested getter properties and any intermediary dot notation ('a.b.c') paths

Install

Install with npm:

$ npm install set-getter --save

Usage

var getter = require('set-getter');

set-getter works like set-value by adding a property to an object or an object hierarchy using dot notation. The main difference is that the property is added using Object.defineProperty and is expected to be a getter function that returns a value.

Example

var obj = {};

// root level property
getter(obj, 'foo', function() {
  return 'bar';
});
console.log(obj.foo);
//=> 'bar'

// property dot notation
getter(obj, 'bar.baz', function() {
  return 'qux';
});
console.log(obj.bar.baz);
//=> 'qux'

// property array notation
getter(obj, ['beep', 'boop'], function() {
  return 'bop';
});
console.log(obj.beep.boop);
//=> 'bop'

API

setGetter

Defines a getter function on an object using property path notation.

Params

  • obj {Object}: Object to add property to.
  • prop {String|Array}: Property string or array to add.
  • getter {Function}: Getter function to add as a property.

Example

var obj = {};
getter(obj, 'foo', function() {
  return 'bar';
});

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

License

Copyright © 2016, Brian Woodward. Released under the MIT license.


This file was generated by verb, v0.9.0, on April 29, 2016.

Versions

Version
0.1.0