Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liqueurdetoile/dotobjectarray
Implements array-like methods for Object with support for dotted notation keys
https://github.com/liqueurdetoile/dotobjectarray
array array-like dot-notation javascript object
Last synced: 21 days ago
JSON representation
Implements array-like methods for Object with support for dotted notation keys
- Host: GitHub
- URL: https://github.com/liqueurdetoile/dotobjectarray
- Owner: liqueurdetoile
- License: mit
- Created: 2018-02-18T13:54:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T21:59:29.000Z (about 2 years ago)
- Last Synced: 2024-12-21T18:07:29.996Z (about 1 month ago)
- Topics: array, array-like, dot-notation, javascript, object
- Language: JavaScript
- Homepage: https://liqueurdetoile.github.io/DotObjectArray/
- Size: 4.38 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/dot-object-array)
[](https://github.com/liqueurdetoile/DotObjectArray)
[](https://cdn.jsdelivr.net/npm/dot-object-array@latest)
[](https://travis-ci.org/liqueurdetoile/DotObjectArray)
[](https://coveralls.io/github/liqueurdetoile/DotObjectArray?branch=master)
[](https://github.com/semantic-release/semantic-release)
[](https://liqueurdetoile.github.io/DotObjectArray/)
[](https://snyk.io/test/github/liqueurdetoile/dotobjectarray?targetFile=package.json) [](https://greenkeeper.io/)
# DotObjectArray, a.k.a. DOA a.k.a. ObjectArray
## Why DOA ?
For three reasons :
- No support for associative arrays in vanilla JS
- Creating deep levels keys in a vanilla JS Object can programmatically be a pain if none of parent keys exists
- Bored of always using the same snippets everywhere and wants to have a less then 10KB NPM dependency ready to import
## Features
DOA is an object with a set of methods to :
- Check, push, get and store data with ease regardless of its level
- Bring some array-like behaviours for convenience (you know `forEach` for arrays, eh ?)
- Provide data serializers and parsers
- Work as well on a whole dataset or a key-based sub-selection of the dataset
- Ease management of options default values
## Quick examples
```javascript
// Import data at creation
var doa = new ObjectArray({
item1: 3,
item2: 12,
item3: 5
});
// Add data
doa.push('item4', 4); // Single item or dataset
doa.import({
item5: 5,
item6: 6
});
// Add data with dotted notations
doa.push('dat.long.darn.key','isntIt?'); // Will automatically create each keys
// Define default values
// Will keep value if existent or create keys with value if not
doa.define('options.section1.item14', true);
//Iterate on keys at root level or in sub dataset
doa.forEach(function(value, key, index) {
[...]
});
doa.forEach(function(value, key, index) {
[...]
}, 'dat.path.to.data');
// Sub dataset import
doa.import({
subitem1: 1,
subitem2: 'astring',
subitem3: {obj: really}
}, 'dat.long.and.far.away.key');
// sub dataset access
doa.dataset('dat.long.and.far.away.key');
// or
doa.pull('dat.long.and.far.away.key');
// And many more !
```
## Installation
### Module
The ObjectArray class is provided as a UMD module.
```
npm install dot-object-array
```
or
```
yarn add dot-object-array
```
Then simply require/import it :
```javascript
import ObjectArray from 'dot-object-array';
const ObjectArray = require('dot-object-array').default;
```
ObjectArray have been coded with ECMA6 class standard.
### Browser
DOA is available as CDN external link or can easily be installed locally.
#### Bundle
```html
```
#### JsDelivr
```html
```
#### Unpkg
```html
```
#### Local install
For browser install, you can simply fetch file `dist/objectarray.min.js` in this repo or clone it and load it :
```html
```
An ObjectArray constructor will be added to global (window) scope.
## Configuring ObjectArray behaviour when a required key doesn't exist
In version 1.x, a non-existent key yields to an `undefined` returned value.
In version 2.x, a non-existent key data request raises an exception except for some methods that can leverage a throwable trigger.
Since version 3.x, the behaviour can be configure per method call or override globally. Each data request have a predefined behaviour
given its goal. For instance, the empty method will throw an exception by default and a dataset call will return undefined by default.
Please check [API reference](https://liqueurdetoile.github.io/DotObjectArray/identifiers.html) for details.
## Playground
If you want to go further and try a bit, you [can go to the playground](https://jsfiddle.net/dx03k9sL/19/).
## Documentation
A full documentation (manual and API reference) set is available :
- [Manual](https://liqueurdetoile.github.io/DotObjectArray/manual/index.html)
- [API reference](https://liqueurdetoile.github.io/DotObjectArray/identifiers.html)
## JSON support
You can easily use ObjectArrays to manipulate JSON data. Just rely on JSON native object to import your JSON structure, manipulate it with ObjectArray ease and get it back at the end :wink:
```javascript
var jstring = '{"dat": {"long": {"path": "foo", "dream": "baz"}}}';
var doa = new ObjectArray(JSON.parse(jstring));
// Let's say we want to move all dat.long stuff to a short thing
doa.push('short', doa.dataset('dat.long')).remove('dat');
console.log(JSON.stringify(doa.data)); // outputs {"short":{"path":"foo","dream":"baz"}}
```
## Bugs and features requests
ObjectArray is test-driven though it did not prevent all issues. Please report here any trouble or features request.
## Want to help ?
There is many more to do to implements othe features. Don't mind fork DOA, tweak it and submit a pull request :wink: