# @terminal-nerds/snippets-object ![package version badge] [![dependencies badge]][dependencies url]\ [![install size badge]][install size url] ➡️ **This package wraps all available modules with snippets related to [object]** — part of the [terminal-nerds/snippets] project. [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object [terminal-nerds/snippets]: https://github.com/terminal-nerds/snippets [package version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-object/latest?style=for-the-badge&logo=npm [dependencies badge]: https://img.shields.io/librariesio/release/npm/@terminal-nerds/snippets-object?style=for-the-badge [dependencies url]: https://libraries.io/npm/@terminal-nerds%2snippets-object [install size badge]: https://packagephobia.com/badge?p=@terminal-nerds/snippets-object [install size url]: https://packagephobia.com/result?p=@terminal-nerds/snippets-object ## Modules included [![documentation badge]][documentation url] [documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io [documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-object | Name | Size | | ------------------------------------------ | ----------------------------------------------------- | | [`@terminal-nerds/snippets-object/keys`] | ![keys size gzip badge] ![keys size brotli badge] | | [`@terminal-nerds/snippets-object/schema`] | ![schema size gzip badge] ![schema size brotli badge] | | [`@terminal-nerds/snippets-object/schema`] | ![schema size gzip badge] ![schema size brotli badge] | [`@terminal-nerds/snippets-object/keys`]: https://github.com/terminal-nerds/snippets/blob/main/packages/object/source/keys/keys.ts [keys size gzip badge]: https://badgen.net/badgesize/gzip/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/keys/keys.js?label=gzip [keys size brotli badge]: https://badgen.net/badgesize/brotli/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/keys/keys.js?label=brotli [`@terminal-nerds/snippets-object/merge`]: https://github.com/terminal-nerds/snippets/blob/main/packages/object/source/merge/merge.ts [merge size gzip badge]: https://badgen.net/badgesize/gzip/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/merge/merge.js?label=gzip [merge size brotli badge]: https://badgen.net/badgesize/brotli/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/merge/merge.js?label=brotli [`@terminal-nerds/snippets-object/schema`]: https://github.com/terminal-nerds/snippets/blob/main/packages/object/source/schema/schema.ts [schema size gzip badge]: https://badgen.net/badgesize/gzip/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/schema/schema.js?label=gzip [schema size brotli badge]: https://badgen.net/badgesize/brotli/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/schema/schema.js?label=brotli --- ## Prerequisites & usage ### Optional [![supported typescript version badge]][typescript] [typescript]: https://typescriptlang.org/ [typescript icon]: https://api.iconify.design/logos/typescript-icon.svg [supported typescript version badge]: https://img.shields.io/github/package-json/dependency-version/terminal-nerds/snippets/peer/typescript?filename=packages%2Ftypescript%2Fpackage.json&logo=typescript&style=for-the-badge&label=typescript If you are using ![typescript icon] [TypeScript], the latest version, which supports new features _(such as `satisfies`)_, is supported. ### Runtime environments This package can be used in several runtime environments. We aim for cross-runtime compatibility and ensure proper error messages if a particular snippet cannot be run in the currently running environment. #### Browsers We use [browserslist] to define the minimum browsers versions supported.\ Take a look at our [shared browserslist configuration] for more details. [browserslist]: https://github.com/browserslist/browserslist [shared browserslist configuration]: https://github.com/terminal-nerds/configs/blob/main/packages/browserslist/source/browsers.ts **Usage**: ```html ``` --- #### Bun We aim to support the latest version of ![bun icon] [bun]. **Usage**: Firstly, install it: ```sh bun add @terminal-nerds/snippets-object ``` And then in a particular file: ```js import { snippet } from "@terminal-nerds/snippets-object"; ``` [bun]: https://bun.sh/ [bun icon]: https://api.iconify.design/logos/bun.svg --- #### Deno We aim to support the latest version of ![deno icon] [Deno]. **Usage**: ```ts import { snippet } from "npm:@terminal-nerds/snippets-object"; ``` [deno]: https://deno.land/ [deno icon]: https://api.iconify.design/logos/deno.svg --- #### Node.js [![node.js version support badge]][node.js] The latest ![node.js icon] [Node.js] LTS _(Long-Term Support)_ version is the minimum one supported. > **Warning**\ > **This package is written in [ES Module] _(ESM)_ type.**\ > So, if you wish to use it in a project with CommonJS (CJS) type, you need to bundle this package or a particular module(s). **Usage**: Install it first with the Node.js package manager of your choice. In our example, we use [pnpm]. ```sh pnpm add @terminal-nerds/snippets-object ``` And then in a particular file: ```js import { snippet } from "@terminal-nerds/snippets-object"; ``` [ES Module]: https://www.freecodecamp.org/news/javascript-es-modules-and-module-bundlers [pnpm]: https://pnpm.io [node.js]: https://nodejs.org/en/ [node.js icon]: https://api.iconify.design/logos/nodejs-icon.svg [node.js version support badge]: https://img.shields.io/node/v-lts/@terminal-nerds/snippets?style=for-the-badge&logo=nodedotjs --- ## Security [![workflow security badge]][security policy] 🔐 For more information, please refer to the [Security section] at the root of the [terminal-nerds/snippets] monorepo. [workflow security badge]: https://img.shields.io/github/actions/workflow/status/terminal-nerds/snippets/maintenance.yml?label=Security&logo=github&style=for-the-badge&branch=main [security section]: https://github.com/terminal-nerds/snippets#security [security policy]: https://github.com/terminal-nerds/snippets/security/policy --- ## License [![license badge]][license] ⚖️ For more information, please refer to the [License section] at the root of the [terminal-nerds/snippets] monorepo. [license]: https://github.com/terminal-nerds/snippets/blob/main/LICENSE.md [license badge]: https://img.shields.io/github/license/terminal-nerds/snippets?style=for-the-badge [license section]: https://github.com/terminal-nerds/snippets#License ### Contributing [![contributors badge]][contributors url] 🤝 **Contributions of any kind are welcome!** Please refer to the monorepo _([terminal-nerds/snippets])_ project's [CONTRIBUTING file] for more information if you wish to get involved. [contributing file]: https://github.com/terminal-nerds/snippets/blob/main/.github/CONTRIBUTING.md [contributors badge]: https://img.shields.io/github/contributors/terminal-nerds/snippets?style=for-the-badge [contributors url]: https://github.com/terminal-nerds/snippets#contributors ### Author 🎉 The idea of this project was initiated by [xeho91]. However, it's the [contributors] who matter the most. [contributors]: https://github.com/terminal-nerds/snippets/blob/main/README.md#project-contributors [xeho91]: https://github.com/xeho91