292 lines
5.7 KiB
Markdown
Executable File
292 lines
5.7 KiB
Markdown
Executable File
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# iterate-object
|
|
|
|
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/iterate-object) [](https://www.npmjs.com/package/iterate-object) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
|
|
|
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> A convenient way to iterate objects.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :cloud: Installation
|
|
|
|
```sh
|
|
# Using npm
|
|
npm install --save iterate-object
|
|
|
|
# Using yarn
|
|
yarn add iterate-object
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :clipboard: Example
|
|
|
|
|
|
|
|
```js
|
|
// Dependencies
|
|
var IterateObject = require("iterate-object");
|
|
|
|
// Iterate this object
|
|
IterateObject({
|
|
name: "Bob"
|
|
, age: 42
|
|
}, function (value, name) {
|
|
console.log(name, value);
|
|
});
|
|
// => "name", "Bob"
|
|
// "age", 42
|
|
|
|
// Iterate an array
|
|
IterateObject([
|
|
1, 2, 3, 4, 5, 6, 7
|
|
], function (value, i) {
|
|
console.log("v[" + i + "] = " + value);
|
|
});
|
|
// => v[0] = 1
|
|
// v[1] = 2
|
|
// v[2] = 3
|
|
// v[3] = 4
|
|
// v[4] = 5
|
|
// v[5] = 6
|
|
// v[6] = 7
|
|
|
|
// Iterate an array
|
|
IterateObject([
|
|
"Alice", "Bob", "Carol", "Dave"
|
|
], function (value, i, arr) {
|
|
console.log("Current: " + value + (arr[i + 1] ? " Next:" + arr[i + 1] : ""));
|
|
});
|
|
// => Current: Alice Next:Bob
|
|
// Current: Bob Next:Carol
|
|
// Current: Carol Next:Dave
|
|
// Current: Dave
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :question: Get Help
|
|
|
|
There are few ways to get help:
|
|
|
|
|
|
|
|
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
|
|
2. For bug reports and feature requests, open issues. :bug:
|
|
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
|
|
|
|
|
|
|
|
|
|
|
|
## :memo: Documentation
|
|
|
|
|
|
### `iterateObject(obj, fn)`
|
|
Iterates an object. Note the object field order may differ.
|
|
|
|
#### Params
|
|
|
|
- **Object** `obj`: The input object.
|
|
- **Function** `fn`: A function that will be called with the current value, field name and provided object.
|
|
|
|
#### Return
|
|
- **Function** The `iterateObject` function.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :yum: How to contribute
|
|
Have an idea? Found a bug? See [how to contribute][contributing].
|
|
|
|
|
|
## :sparkling_heart: Support my projects
|
|
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
|
|
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
|
|
|
|
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
|
|
|
|
|
|
- Starring and sharing the projects you like :rocket:
|
|
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
|
|
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
|
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
|
|
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
|
|
|
|
|
|
|
|
|
|
Thanks! :heart:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :dizzy: Where is this library used?
|
|
If you are using this library in one of your projects, add it in this list. :sparkles:
|
|
|
|
- `edit-json-file`
|
|
- `scrape-it`
|
|
- `err`
|
|
- `tilda`
|
|
- `emojic`
|
|
- `couleurs`
|
|
- `lien`
|
|
- `oargv`
|
|
- `map-o`
|
|
- `html-encoder-decoder`
|
|
- `emoji-name-map`
|
|
- `elly`
|
|
- `barbe`
|
|
- `color-it`
|
|
- `obj-flatten`
|
|
- `xml-jsonify`
|
|
- `emoji-unicode-map`
|
|
- `emoji-from-word`
|
|
- `bloggify-template-renderer`
|
|
- `bloggify-page`
|
|
- `match`
|
|
- `error-creator`
|
|
- `obj-unflatten`
|
|
- `bloggify-redirect`
|
|
- `bloggify-actions`
|
|
- `rucksack`
|
|
- `bloggify-flexible-router`
|
|
- `git-stats`
|
|
- `@rivkesse/emoji-category-map`
|
|
- `bloggify-config`
|
|
- `svg.connectable.js`
|
|
- `engine-parser`
|
|
- `engine-builder`
|
|
- `enny`
|
|
- `engine-flow-types`
|
|
- `mini-lightbox`
|
|
- `nodeice`
|
|
- `bloggify-mongoose`
|
|
- `gm-tools`
|
|
- `bloggify-shortcode`
|
|
- `bloggify-paths`
|
|
- `stringify-env`
|
|
- `bloggify-theme-renderer`
|
|
- `bloggify-on-request`
|
|
- `scrape-it-plus`
|
|
- `@slikts/scrape-it`
|
|
- `love-you`
|
|
- `remove-one-element-arrays`
|
|
- `validate5`
|
|
- `bloggify-sequelize`
|
|
- `@isysd/gpm`
|
|
- `emoji.css`
|
|
- `gpm`
|
|
- `gh-following`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :scroll: License
|
|
|
|
[MIT][license] © [Ionică Bizău][website]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[license]: /LICENSE
|
|
[website]: http://ionicabizau.net
|
|
[contributing]: /CONTRIBUTING.md
|
|
[docs]: /DOCUMENTATION.md
|
|
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
|
|
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
|
|
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
|
|
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
|
|
[patreon]: https://www.patreon.com/ionicabizau
|
|
[amazon]: http://amzn.eu/hRo9sIZ
|
|
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
|