Odin

🔱 Odin is an Object wrapper that allows you to create objects and set their attributes - all at once! 🔺

📃 Table of Contents

• Features
• Usage
• API
• Examples
• Changelog
• Support
• License
• Related
• Author

🤖 Features

• ⚡ Fast merge - Assigns all source props to target in one go
• 🛡 Type‑safe - Leverages TS generics for compile‑time checks
• 🧩 Shallow copy - Efficiently copies only top‑level properties
• 🔄 In‑place update - Mutates and returns the target object
• 📝 Clear signature - Simple, predictable API
• 📦 Zero dependencies - Pure TypeScript, no extras
• 🌍 Cross‑platform - Works in browser and Node.js
• 🧠 Safe defaults - Handles missing or invalid inputs gracefully

🕵🏼 Usage

Install it by executing any of the following, depending on your preferred package manager:

pnpm add @igorskyflyer/odin

yarn add @igorskyflyer/odin

npm i @igorskyflyer/odin

🤹🏼 API

odin(target: object, source: object): object

Assigns all properties of the source object to the target object.

target: object - the target object to copy properties to,

source: object - the source object to copy properties from.

Returns the target object.

If the target object is not provided and empty object is returned.

If the source object is not provided the target object is returned unchanged.

ℹ️ NOTE

Shallow vs deep copy

This function uses the method of shallow copying of the source object, for deep/true copied objects consider using clone.js.

For more info, see, shallow copy vs deep copy.

🗒️ Examples

import { odin } from '@igorskyflyer/odin'

const cloned: object = odin({ a: 1, b: 2 }, { c: 3 }) // returns { a: 1, b: 2, c: 3 }

📝 Changelog

📑 The changelog is available here, CHANGELOG.md.

🪪 License

Licensed under the MIT license which is available here, MIT license.

💖 Support

I work hard for every project, including this one and your support means a lot to me!
Consider buying me a coffee. ☕



Thank you for supporting my efforts! 🙏😊

🧬 Related

@igorskyflyer/common-color

🎨 Provides common Color-related TypeScript types. 🌈

@igorskyflyer/magic-queryselector

🪄 A TypeScript-types patch for querySelector/querySelectorAll, make them return types you expect them to! 🔮

@igorskyflyer/upath

🎍 Provides a universal way of formatting file-paths in Unix-like and Windows operating systems as an alternative to the built-in path.normalize(). 🧬

@igorskyflyer/strip-yaml-front-matter

🦓 Strips YAML front matter from a String or a file. 👾

@igorskyflyer/registry-apppaths

🪀 A Node.js module for reading the AppPaths registry key on Windows. Useful for retrieving applications that can be launched from the command prompt. 🗃

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).