Object Extractor

Overview

The extract function retrieves values from a source object using a list of paths. For each specified key, multiple paths can be provided, and the function returns the value from the first valid path found.

---

Installation

Node

1npm install @nicebuzzy/object-extractor

Browser

1<script type="module">
2  import extract from 'https://esm.run/@nicebuzzy/object-extractor'
3</script>

---

Usage

1import extract from '@nicebuzzy/object-extractor'
2
3const user = {
4  theme: 'light'
5}
6
7const settings = {
8  theme: 'dark',
9  notifications: {
10    email: true
11  }
12}
13
14const variables = {
15  username: ['name', 'username'],
16  theme: ['theme'],
17  notification: ['notifications.sms', 'notifications.email']
18}
19
20const result = extract(variables, user, settings)
21
22console.log(result) // { theme: 'light', notification: true }

---

API Reference

extract(variables, ...sources)

Returns: Object

• variables: Object
  An object where each key represents the name of the variable in the resulting object, and the value is an array of paths (as dot-separated strings) to search for the corresponding value in the sources.

• sources: ...Object
  One or more source objects from which values will be extracted. The function searches for values in the order of the provided sources, using the first valid path found.

---