Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/modules/define-properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
description: Native alternatives to the define-properties package for defining multiple object properties
---

# Replacements for `define-properties`

## `Object.defineProperties` (native)

[`Object.defineProperties`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperties) can define multiple properties on an object without an extra dependency.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to show a diff for migration like in https://github.com/e18e/module-replacements/blob/main/docs/modules/clipboardy.md for example

Example:

```ts
import defineProperties from 'define-properties' // [!code --]

const obj = {}
const descriptors = {
enabled: {
configurable: true,
enumerable: false,
value: true,
writable: false
}
}

defineProperties(obj, { enabled: true }) // [!code --]
Object.defineProperties(obj, descriptors) // [!code ++]
```

`define-properties` also skips existing properties unless a matching predicate returns `true`. If your code relies on that behavior, keep the condition outside the descriptor map when migrating:

```ts
import defineProperties from 'define-properties' // [!code --]

const descriptors = {
enabled: {
configurable: true,
enumerable: false,
value: true,
writable: false
}
}

defineProperties(obj, { enabled: true }, { enabled: shouldOverrideEnabled }) // [!code --]
if (!Object.hasOwn(obj, 'enabled') || shouldOverrideEnabled()) {
// [!code ++]
Object.defineProperties(obj, descriptors) // [!code ++]
}
```
Comment on lines +31 to +49

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a diff for this too please?

5 changes: 0 additions & 5 deletions manifests/native.json
Original file line number Diff line number Diff line change
Expand Up @@ -2131,11 +2131,6 @@
"moduleName": "define-data-property",
"replacements": ["Object.defineProperty"]
},
"define-properties": {
"type": "module",
"moduleName": "define-properties",
"replacements": ["Object.defineProperties"]
},
"define-property": {
"type": "module",
"moduleName": "define-property",
Expand Down
18 changes: 18 additions & 0 deletions manifests/preferred.json
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,12 @@
"replacements": ["dequal", "util.isDeepStrictEqual", "Bun.deepEquals"],
"url": {"type": "e18e", "id": "deep-equal"}
},
"define-properties": {
"type": "module",
"moduleName": "define-properties",
"replacements": ["Object.defineProperties"],
"url": {"type": "e18e", "id": "define-properties"}
},
"depcheck": {
"type": "module",
"moduleName": "depcheck",
Expand Down Expand Up @@ -2918,6 +2924,18 @@
"id": "Web/JavaScript/Reference/Global_Objects/Intl/Segmenter"
}
},
"Object.defineProperties": {
"id": "Object.defineProperties",
"type": "native",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Global_Objects/Object/defineProperties"
},
"webFeatureId": {
"featureId": "object-object",
"compatKey": "javascript.builtins.Object.defineProperties"
}
},
"Promise": {
"id": "Promise",
"type": "native",
Expand Down