Feature request: Convert an Object into dot-delimited paths

[maoosi]

Guidelines

• Please search other issues to make sure this feature has not already been requested.

Which problem is this feature request solving?

Thanks for the work, very useful library!

One thing I’d love to see added is the ability to convert an Object into dot-delimited paths.

Describe the solution you'd like

Example:

dotate({
  username: 'johndoe',
  profile: { image: 'avatar.jpg', verified: true, views: 5 },
  tags: ['foo', 'bar']
}, { keepArrays })

Result with keepArrays: true:

{
  "username": "johndoe",
  "profile.image": "avatar.jpg",
  "profile.verified": true,
  "profile.views": 5,
  "tags": ["foo", "bar"]
}

Result with keepArrays: false:

{
  "username": "johndoe",
  "profile.image": "avatar.jpg",
  "profile.verified": true,
  "profile.views": 5,
  "tags.0": "foo",
  "tags.1": "bar"
}

Pull request (optional)

• I can submit a pull request.

[ehmicky]

Hi @maoosi,

Thanks for the request!
Good ideas, let me work on it and reach back. 👍

[ehmicky]

This is now available in wild-wild-utils 4.5.0. 🎉

wild-wild-path focuses on CRUD operations, while wild-wild-utils on functional utilities like the one you described, which is why this was added to that other repository.

The new method is named flatten() and is documented here and there.

import { flatten } from 'wild-wild-utils'

const target = {
  username: 'johndoe',
  profile: { image: 'avatar.jpg', verified: true, views: 5 },
  tags: ['foo', 'bar']
}
flatten(target)
// {
//   "username": "johndoe",
//   "profile.image": "avatar.jpg",
//   "profile.verified": true,
//   "profile.views": 5,
//   "tags.0": "foo",
//   "tags.1": "bar"
// }
flatten(target, { sort: true })
// {
//   "profile.image": "avatar.jpg",
//   "profile.verified": true,
//   "profile.views": 5,
//   "tags.0": "foo",
//   "tags.1": "bar",
//   "username": "johndoe"
// }
flatten(target, { shallowArrays: true })
// {
//   "username": "johndoe",
//   "profile.image": "avatar.jpg",
//   "profile.verified": true,
//   "profile.views": 5,
//   "tags": ["foo", "bar"]
// }

As part of this, I also added a new option shallowArrays to both wild-wild-path and wild-wild-utils. When set to true, it prevents recursing on arrays.

Please note the dot-delimited paths are safe to use with other wild-wild-path and wild-wild-utils methods. For example, if a property key is odd (e.g. is an empty string, or has a dot in it), it will be properly escaped.

I hope this works!

[ehmicky]

@all-contributors Please add @maoosi for those great ideas.

[allcontributors]

@ehmicky

I've put up a pull request to add @maoosi! 🎉

[maoosi]

Wow that was quick @ehmicky, awesome work!

I should now be able to use wild-wild-utils as a dependency to my own OSS project and simplify/strengthen some parts: https://github.com/maoosi/prisma-appsync

Thanks!