Skip to content

Commit

Permalink
Deprecate some property helpers
Browse files Browse the repository at this point in the history
Document the preference for `verifyProperty` over the various other
property-related helper functions.
  • Loading branch information
jugglinmike authored and rwaldron committed Apr 4, 2022
1 parent 5eb7dfb commit 276e79d
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions harness/propertyHelper.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: |
property descriptors.
defines:
- verifyProperty
- verifyEqualTo
- verifyWritable
- verifyNotWritable
- verifyEnumerable
- verifyNotEnumerable
- verifyConfigurable
- verifyNotConfigurable
- verifyEqualTo # deprecated
- verifyWritable # deprecated
- verifyNotWritable # deprecated
- verifyEnumerable # deprecated
- verifyNotEnumerable # deprecated
- verifyConfigurable # deprecated
- verifyNotConfigurable # deprecated
---*/

// @ts-check
Expand Down Expand Up @@ -173,13 +173,19 @@ function isWritable(obj, name, verifyProp, value) {
return writeSucceeded;
}

/**
* Deprecated; please use `verifyProperty` in new tests.
*/
function verifyEqualTo(obj, name, value) {
if (!isSameValue(obj[name], value)) {
throw new Test262Error("Expected obj[" + String(name) + "] to equal " + value +
", actually " + obj[name]);
}
}

/**
* Deprecated; please use `verifyProperty` in new tests.
*/
function verifyWritable(obj, name, verifyProp, value) {
if (!verifyProp) {
assert(Object.getOwnPropertyDescriptor(obj, name).writable,
Expand All @@ -190,6 +196,9 @@ function verifyWritable(obj, name, verifyProp, value) {
}
}

/**
* Deprecated; please use `verifyProperty` in new tests.
*/
function verifyNotWritable(obj, name, verifyProp, value) {
if (!verifyProp) {
assert(!Object.getOwnPropertyDescriptor(obj, name).writable,
Expand All @@ -200,6 +209,9 @@ function verifyNotWritable(obj, name, verifyProp, value) {
}
}

/**
* Deprecated; please use `verifyProperty` in new tests.
*/
function verifyEnumerable(obj, name) {
assert(Object.getOwnPropertyDescriptor(obj, name).enumerable,
"Expected obj[" + String(name) + "] to have enumerable:true.");
Expand All @@ -208,6 +220,9 @@ function verifyEnumerable(obj, name) {
}
}

/**
* Deprecated; please use `verifyProperty` in new tests.
*/
function verifyNotEnumerable(obj, name) {
assert(!Object.getOwnPropertyDescriptor(obj, name).enumerable,
"Expected obj[" + String(name) + "] to have enumerable:false.");
Expand All @@ -216,6 +231,9 @@ function verifyNotEnumerable(obj, name) {
}
}

/**
* Deprecated; please use `verifyProperty` in new tests.
*/
function verifyConfigurable(obj, name) {
assert(Object.getOwnPropertyDescriptor(obj, name).configurable,
"Expected obj[" + String(name) + "] to have configurable:true.");
Expand All @@ -224,6 +242,9 @@ function verifyConfigurable(obj, name) {
}
}

/**
* Deprecated; please use `verifyProperty` in new tests.
*/
function verifyNotConfigurable(obj, name) {
assert(!Object.getOwnPropertyDescriptor(obj, name).configurable,
"Expected obj[" + String(name) + "] to have configurable:false.");
Expand Down

0 comments on commit 276e79d

Please sign in to comment.