@thi.ng/object-utils

[!NOTE] This is one of 200 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

• About
  • Features
• Status
• Related packages
• Installation
• Dependencies
• API
• Authors
• License

About

Utilities for manipulating plain JS objects & maps.

This package contains functionality which was previously part of and has been extracted from the @thi.ng/associative package.

Features

• Key-value pair inversion for maps and vanilla objects, i.e. swaps K => V to V => K
• Single or multi-property index generation for maps and objects
• Key selection, renaming, segmenting, splitting, transformations for maps and objects
• Deep-merging (destructively & non-destructively) of objects/maps

Status

STABLE - used in production

Search or submit any issues for this package

Related packages

• @thi.ng/associative - ES Map/Set-compatible implementations with customizable equality semantics & supporting operations

Installation

yarn add @thi.ng/object-utils

ESM import:

import * as ou from "@thi.ng/object-utils";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/object-utils"></script>

JSDelivr documentation

For Node.js REPL:

const ou = await import("@thi.ng/object-utils");

Package sizes (brotli'd, pre-treeshake): ESM: 1.16 KB

Dependencies

• @thi.ng/api
• @thi.ng/checks

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

API

Generated API docs

TODO

Authors

• Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-object-utils,
  title = "@thi.ng/object-utils",
  author = "Karsten Schmidt",
  note = "https://thi.ng/object-utils",
  year = 2017
}

License

© 2017 - 2024 Karsten Schmidt // Apache License 2.0