This method removes the given path from the flatten object.

Most of the time removing one path is a trivial thing but when it comes to arrays it is more complicated than just simply removing its key.

Usage

import { flat } from 'admin-bro'

// do something with flat.removePath
const paramsWithoutName = flat.removePath(otherParams, 'name.0')

Why it exists?

Take a look at this example:

having the flatten object

{
  'property.0': 'val1',
  'property.1': 'val2',
  'property.2': 'val3',
}

you want to remove property.1 path. In order to do this you will need to remove key property.1 and rename property.2 to property.1

and take a look at this example:

{
  name: 'value',
  'notPopulated.0': 'val1',
  'notPopulated.1': 'val2',
  'property.0': 'val1',
  'property.1': 'val2',
  'property.2': 'val3',
  'property.3.nested.0': 'val1',
  'property.3.nested.1': 'val2',
  'property.3.nested.2': 'val3',
  'property.3.nested.3.some': 'val3',
  'property.3.nested.4.some-other': 'val41',
  'property.4': 'val4',
  'property.5.nested.0': 'val5',
}

what should happen when you want to remove property.3.nested.3.some ?

This function solves these problems for you.

Raw flatten function exported from original flat package.

Raw unflatten function exported from original flat package.

From all keys in params it removes this passed in an argument.

Example

import flat from '@admin-bro'

const params = {
  name: 'John',
  'education.school.name': 'Harvard',
  'education.school.id': 123,
}

flat.filterOutParams(params, 'education.school')
// results to {
//   name: 'John',
// }

flat.filterOurParams(params, 'name')
// results to {
//   'education.school.name': 'Harvard',
//   'education.school.id': 123,
// }

Returns sub-property from the flatten params. When the property path is not given function returns an entire unflatten object.

Example

import flat from '@admin-bro'

const params = {
  name: 'John',
  'education.school.name': 'Harvard',
  'education.school.id': 123,
}

const data = flat.get(params, 'education.school')
// results to {
//   name: 'Harvard',
//   id: 321,
// }

// value is undefined
const data = flat.get(params)
// results to {
//   name: 'John',
//   education: {
//     school: {
//       name: 'Harvard',
//       id: 321,
//     }
//   }
// }

Merges params together and returns flatten result

From all keys in params it selects only those passed in arguments.

Example

import flat from '@admin-bro'

const params = {
  name: 'John',
  'education.school.name': 'Harvard',
  'education.school.id': 123,
}

flat.selectParams(params, 'education.school')
// results to {
//   'education.school.name': 'Harvard',
//   'education.school.id': 123,
// }

flat.selectParams(params, 'education.school.id', 'name')
// results to {
//   'name': 'John',
//   'education.school.id': 123,
// }

Updates the flatten param object with a given value. Value can be anything and, this anything will be flattened and added to params.

params is not mutated here.

Example

import flat from '@admin-bro'

const params = {
  name: 'John',
  'education.school.name': 'Harvard',
  'education.school.id': 123,
}

const data = flat.set(params, 'education.shool', {
  name: 'Yale',
  id: 321,
})
// results to data === {
//   name: 'John',
//   'education.school.name': 'Yale`,
//   'education.school.id': 321,
// }

// value is undefined
const data = flat.set(params, 'education') // results to data === { name: 'John' }

the Long story short this method:

• changes: nested.nested2.normalInner
• to ["nested", "nested.nested2", "nested.nested2.normalInner"]

So it can be used to search for the param in a FlattenParams object.

Formally it changes path in "flatten" notation, to an Array of all possible keys, which could have searched property.

When skipArrayIndexes is set to true it also it takes care of the arrays, which are separated by numbers (indexes). Then it:

• changes: nested.0.normalInner.1
• to: nested.normalInner

Everything because when we look for a property of a given path it can be inside a mixed property. So first, we have to find top-level mixed property, and then, step by step, find inside each of them.

Type of flatten params.

Available types for flatten values. This is an Union of types:

• string
• boolean
• number
• Date
• null
• [] (empty array)
• {} (empty object)
• File