Finish initial proposal

Author: BridgeAR

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 ECMA TC39 and contributors
+Copyright (c) 2025 Ruben Bridgewater
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -21,7 +21,7 @@ const obj = { a: 1, b: 2 };
 const count = Object.keys(obj).length;
 ```
 
-However, this approach creates unnecessary memory overhead and garbage collection pressure, as an intermediate array is allocated solely for counting properties. Highly-used runtimes, frameworks, and libraries (e.g., Node.js, React, Lodash, Angular) frequently utilize `Object.keys(obj).length`, compounding performance issues across applications.
+However, this approach creates unnecessary memory overhead and garbage collection pressure, as an intermediate array is allocated solely for counting properties. Highly-used runtimes, frameworks, and libraries (e.g., Node.js, React, Lodash, Angular, Storybook, Excalidraw, VS Code, Svelte, Next.js, three.js, Puppeteer, Tailwind, ...) frequently utilize `Object.keys(obj).length`, compounding performance issues across applications.
 
 For instance, React often counts props or state keys:
 
@@ -239,33 +239,7 @@ The native implementation should strictly avoid creating intermediate arrays or
      - If the property meets all criteria, increment the counter.
 3. Return the final count value.
 
-### Object.propertyCount ( _target_ [, _options_ ] )
-
-When the `propertyCount` method is called, the following steps are taken:
-
-**This is work in progress! The Algorithm is not yet fully defined.**
-
-1. If Type(_target_) is not Object, throw a TypeError exception.
-2. If _options_ is undefined, let _options_ be an empty Object.
-3. Let _keyTypes_ be ? Get(_options_, "keyTypes").
-4. If _keyTypes_ is undefined, set _keyTypes_ to the array `['index', 'nonIndexString']`.
-5. Else, perform the following:
-    1. If Type(_keyTypes_) is not Object, throw a TypeError exception.
-    2. Set _keyTypes_ to an internal List whose elements are the String values of the elements of _keyTypes_.
-    3. If _keyTypes_ contains any value other than "index", "nonIndexString", or "symbol", throw a TypeError exception.
-1. Let _enumerable_ be ? Get(_options_, "enumerable").
-2. If _enumerable_ is undefined, set _enumerable_ to true.
-3. Else if _enumerable_ is not one of true, false, or "all", throw a TypeError exception.
-4.  Let _count_ be 0.
-5.  Let _ownKeys_ be the List of own property keys of _target_, in the order returned by OrdinaryOwnPropertyKeys(_target_). (Note: No intermediate array should be allocated.)
-6.  For each element _key_ of _ownKeys_, perform the following steps:
-    1. Let _desc_ be ? OrdinaryGetOwnProperty(_target_, _key_).
-    2. If _enumerable_ is not 'all'
-        i. If _enumerable_ is unequal to _desc_.[[Enumerable]], continue to the next _key_.
-    3. If Type(_key_) is Symbol and "symbol" is present in _keyTypes_, increment _count_ by 1.
-    4. Else if Type(_key_) is array index and "index" is present in _keyTypes_, increment _count_ by 1.
-    5. Else if "nonIndexString" is present in _keyTypes_, increment _count_ by 1
-7.  Return _count_.
+See the [spec proposal](./spec.emu) for details.
 
 ## Alternatives Considered
 
@@ -291,8 +265,16 @@ Frequent patterns in widely-used JavaScript runtimes, frameworks, and libraries
 ```javascript
 const validTypes = new Set(['index', 'nonIndexString', 'symbol']);
 
-Object.propertyCount = function(target, options = {}) {
-  const { keyTypes = ['index', 'nonIndexString'], enumerable = true } = options;
+Object.propertyCount = function(target, options) {
+  if (typeof target !== 'object' || target === null) {
+    throw new TypeError(`Expected target to be an object. Received ${typeof target}`);
+  }
+
+  if (options === undefined) {
+    return Object.keys(target).length;
+  }
+
+  const { keyTypes = ['index', 'nonIndexString'], enumerable = true } = options || {};
 
   for (const type of keyTypes) {
     if (!validTypes.has(type)) {
@@ -307,13 +289,11 @@ Object.propertyCount = function(target, options = {}) {
   let props = [];
 
   if (keyTypes.includes('index') || keyTypes.includes('nonIndexString')) {
-    let stringProps = Object.getOwnPropertyNames(target);
+    let stringProps = enumerable === 'all' ? Object.getOwnPropertyNames(target) ? Object.keys(target);
 
     if (!keyTypes.includes('nonIndexString')) {
       stringProps = stringProps.filter(key => String(parseInt(key, 10)) === key && parseInt(key, 10) >= 0);
-    }
-
-    if (!keyTypes.includes('index')) {
+    } else if (!keyTypes.includes('index')) {
       stringProps = stringProps.filter(key => String(parseInt(key, 10)) !== key || parseInt(key, 10) < 0);
     }
 

package.json

@@ -1,16 +1,16 @@
 {
   "private": true,
-  "name": "template-for-proposals",
-  "description": "A repository template for ECMAScript proposals.",
+  "name": "object-property-count",
+  "description": "Proposal for a fast way to count object properties.",
   "scripts": {
     "start": "npm run build-loose -- --watch",
     "build": "npm run build-loose -- --strict",
     "build-loose": "node -e 'fs.mkdirSync(\"build\", { recursive: true })' && ecmarkup --load-biblio @tc39/ecma262-biblio --verbose spec.emu build/index.html --lint-spec"
   },
-  "homepage": "https://github.com/tc39/template-for-proposals#readme",
+  "homepage": "https://github.com/BridgeAR/object-property-count#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tc39/template-for-proposals.git"
+    "url": "git+https://github.com/BridgeAR/object-property-count.git"
   },
   "license": "MIT",
   "devDependencies": {

spec.emu

@@ -4,36 +4,60 @@
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/github.min.css">
 <script src="./spec.js"></script>
 <pre class="metadata">
-title: Proposal Title Goes Here
+title: Object.propertyCount
 stage: -1
-contributors: Your Name(s) Here
+contributors: Ruben Bridgewater
 </pre>
 
 <emu-clause id="sec-demo-clause">
-  <h1>This is an emu-clause</h1>
-  <p>This is an algorithm:</p>
+  <h1>Object.propertyCount ( _target_ [ , _options_ ] )</h1>
+  <p>When the `Object.propertyCount` method is called, the following steps are taken:</p>
   <emu-alg>
-    1. Let _proposal_ be *undefined*.
-    1. If IsAccepted(_proposal_) is *true*, then
-      1. Let _stage_ be *0*<sub>ℤ</sub>.
-    1. Else,
-      1. Let _stage_ be *-1*<sub>ℤ</sub>.
-    1. Return ? ToString(_stage_).
+    1. If _target_ is not an Object, throw a TypeError exception.
+    1. Let _resolvedOptions_ be ? GetOptionsObject(_options_).
+    1. Let _keyTypes_ be ? Get(_resolvedOptions_, "keyTypes").
+    1. If _keyTypes_ is undefined, then
+        1. Set _keyTypes_ to the array `['index', 'nonIndexString']`.
+    1. Else, perform the following,
+        1. If _keyTypes_ is not an Object, throw a TypeError exception.
+        1. Set _keyTypes_ to an internal List whose elements are the String values of the elements of _keyTypes_.
+        1. If _keyTypes_ contains any value other than "index", "nonIndexString", or "symbol", throw a TypeError exception.
+    1. Let _enumerable_ be ? Get(_resolvedOptions_, "enumerable").
+    1. If _enumerable_ is undefined, set _enumerable_ to true.
+    1. Else if _enumerable_ is not one of true, false, or "all", throw a TypeError exception.
+    1. Let _count_ be 0.
+    1. Let _ownKeys_ be the List of own property keys of _target_, in the order returned by OrdinaryOwnPropertyKeys(_target_). (Note: No intermediate array should be allocated.)
+    1. For each element _key_ of _ownKeys_, perform the following steps, do
+        1. Let _desc_ be OrdinaryGetOwnProperty(_target_, _key_).
+        1. If _enumerable_ is not 'all', then
+            1. If _enumerable_ is unequal to _desc_.[[Enumerable]], continue to the next _key_.
+        1. If _key_ is Symbol and "symbol" is present in _keyTypes_, increment _count_ by 1.
+        1. Else if _key_ is an array index and "index" is present in _keyTypes_, increment _count_ by 1.
+        1. Else if "nonIndexString" is present in _keyTypes_, increment _count_ by 1.
+    1. Return _count_.
   </emu-alg>
 </emu-clause>
 
-<emu-clause id="sec-is-accepted" type="abstract operation">
+<!-- Copied from ECMA-402 GetOptionsObject -->
+
+<emu-clause id="sec-getoptionsobject" type="abstract operation">
   <h1>
-      IsAccepted (
-        _proposal_: an ECMAScript language value
-      ): a Boolean
+    GetOptionsObject (
+      _options_: an ECMAScript language value,
+    ): either a normal completion containing an Object or a throw completion
   </h1>
   <dl class="header">
     <dt>description</dt>
-    <dd>Tells you if the proposal was accepted</dd>
+    <dd>
+      It returns an Object suitable for use with GetOption, either _options_ itself or a default empty Object.
+      It throws a *TypeError* if _options_ is not *undefined* and not an Object.
+    </dd>
   </dl>
   <emu-alg>
-    1. If _proposal_ is not a String, or is not accepted, return *false*.
-    1. Return *true*.
+    1. If _options_ is *undefined*, then
+      1. Return OrdinaryObjectCreate(*null*).
+    1. If _options_ is an Object, then
+      1. Return _options_.
+    1. Throw a *TypeError* exception.
   </emu-alg>
 </emu-clause>