Add buffer getters and setters to binary.js

[Pisces] / object.js

diff --git a/object.js b/object.js
index 71b81dbf360277c990c9aeaab874d62626682f56..a4037951fcd77fa746e8aabe23a974948e29ed9a 100644 (file)
--- a/object.js
+++ b/object.js
@@ -28,12 +28,12 @@ import { ITERATOR, SPECIES, toPrimitive, type } from "./value.js";
  * Methods will be called with the resulting object as their this
  * value.
  *
  * Methods will be called with the resulting object as their this
  * value.
  *

- * LazyLoader objects have the same prototype as the passed methods
+ * `LazyLoader` objects have the same prototype as the passed methods

  * object.
  */
 export class LazyLoader extends null {
   /**
  * object.
  */
 export class LazyLoader extends null {
   /**

-   * Constructs a new LazyLoader object.
+   * Constructs a new `LazyLoader` object.

    *
    * ☡ This function throws if the provided value is not an object.
    */
    *
    * ☡ This function throws if the provided value is not an object.
    */


@@ -96,7 +96,7 @@ export const { PropertyDescriptor } = (() => {
      * object.
      *
      * The resulting object is proxied to enforce types (for example,
      * object.
      *
      * The resulting object is proxied to enforce types (for example,

-     * its `enumerable` property, if defined, will always be a
+     * its `.enumerable` property, if defined, will always be a

      * boolean).
      */
     constructor(O) {
      * boolean).
      */
     constructor(O) {


@@ -395,7 +395,7 @@ export const {
    * descriptors on the enumerable own properties of the provided
    * additional objects.
    *
    * descriptors on the enumerable own properties of the provided
    * additional objects.
    *

-   * ※ This differs from Object.defineProperties in that it can take
+   * ※ This differs from `Object.defineProperties` in that it can take

    * multiple source objects.
    */
   defineOwnProperties,
    * multiple source objects.
    */
   defineOwnProperties,


@@ -419,7 +419,7 @@ export const {
    * Defines an own property on the provided object on the provided
    * property key using the provided property descriptor.
    *
    * Defines an own property on the provided object on the provided
    * property key using the provided property descriptor.
    *

-   * ※ This is an alias for Object.defineProperty.
+   * ※ This is an alias for `Object.defineProperty`.

    */
   defineProperty: defineOwnProperty,
 
    */
   defineProperty: defineOwnProperty,
 


@@ -428,7 +428,7 @@ export const {
    * properties as nonconfigurable and (if data properties)
    * nonwritable, and returns the object.
    *
    * properties as nonconfigurable and (if data properties)
    * nonwritable, and returns the object.
    *

-   * ※ This is an alias for Object.freeze.
+   * ※ This is an alias for `Object.freeze`.

    */
   freeze,
 
    */
   freeze,
 


@@ -437,7 +437,7 @@ export const {
    * provided property key on the provided object, or null if none
    * exists.
    *
    * provided property key on the provided object, or null if none
    * exists.
    *

-   * ※ This is an alias for Object.getOwnPropertyDescriptor.
+   * ※ This is an alias for `Object.getOwnPropertyDescriptor`.

    */
   getOwnPropertyDescriptor,
 
    */
   getOwnPropertyDescriptor,
 


@@ -445,7 +445,7 @@ export const {
    * Returns the property descriptors for the own properties on the
    * provided object.
    *
    * Returns the property descriptors for the own properties on the
    * provided object.
    *

-   * ※ This is an alias for Object.getOwnPropertyDescriptors.
+   * ※ This is an alias for `Object.getOwnPropertyDescriptors`.

    */
   getOwnPropertyDescriptors,
 
    */
   getOwnPropertyDescriptors,
 


@@ -455,7 +455,7 @@ export const {
    *
    * ☡ This includes both enumerable and non·enumerable properties.
    *
    *
    * ☡ This includes both enumerable and non·enumerable properties.
    *

-   * ※ This is an alias for Object.getOwnPropertyNames.
+   * ※ This is an alias for `Object.getOwnPropertyNames`.

    */
   getOwnPropertyNames: getOwnPropertyStrings,
 
    */
   getOwnPropertyNames: getOwnPropertyStrings,
 


@@ -465,14 +465,14 @@ export const {
    *
    * ☡ This includes both enumerable and non·enumerable properties.
    *
    *
    * ☡ This includes both enumerable and non·enumerable properties.
    *

-   * ※ This is an alias for Object.getOwnPropertySymbols.
+   * ※ This is an alias for `Object.getOwnPropertySymbols`.

    */
   getOwnPropertySymbols,
 
   /**
    * Returns the prototype of the provided object.
    *
    */
   getOwnPropertySymbols,
 
   /**
    * Returns the prototype of the provided object.
    *

-   * ※ This is an alias for Object.getPrototypeOf.
+   * ※ This is an alias for `Object.getPrototypeOf`.

    */
   getPrototypeOf: getPrototype,
 
    */
   getPrototypeOf: getPrototype,
 


@@ -480,36 +480,36 @@ export const {
    * Returns whether the provided object has an own property with the
    * provided property key.
    *
    * Returns whether the provided object has an own property with the
    * provided property key.
    *

-   * ※ This is an alias for Object.hasOwn.
+   * ※ This is an alias for `Object.hasOwn`.

    */
   hasOwn: hasOwnProperty,
 
   /**
    * Returns whether the provided object is extensible.
    *
    */
   hasOwn: hasOwnProperty,
 
   /**
    * Returns whether the provided object is extensible.
    *

-   * ※ This is an alias for Object.isExtensible.
+   * ※ This is an alias for `Object.isExtensible`.

    */
    */

-  isExtensible,
+  isExtensible: isExtensibleObject,

 
   /**
    * Returns whether the provided object is frozen.
    *
 
   /**
    * Returns whether the provided object is frozen.
    *

-   * ※ This is an alias for Object.isFrozen.
+   * ※ This is an alias for `Object.isFrozen`.

    */
    */

-  isFrozen,
+  isFrozen: isFrozenObject,

 
   /**
    * Returns whether the provided object is sealed.
    *
 
   /**
    * Returns whether the provided object is sealed.
    *

-   * ※ This is an alias for Object.isSealed.
+   * ※ This is an alias for `Object.isSealed`.

    */
    */

-  isSealed,
+  isSealed: isSealedObject,

 
   /**
    * Returns an array of key~value pairs for the enumerable,
    * string‐valued property keys on the provided object.
    *
 
   /**
    * Returns an array of key~value pairs for the enumerable,
    * string‐valued property keys on the provided object.
    *

-   * ※ This is an alias for Object.entries.
+   * ※ This is an alias for `Object.entries`.

    */
   entries: namedEntries,
 
    */
   entries: namedEntries,
 


@@ -517,7 +517,7 @@ export const {
    * Returns an array of the enumerable, string‐valued property keys on
    * the provided object.
    *
    * Returns an array of the enumerable, string‐valued property keys on
    * the provided object.
    *

-   * ※ This is an alias for Object.keys.
+   * ※ This is an alias for `Object.keys`.

    */
   keys: namedKeys,
 
    */
   keys: namedKeys,
 


@@ -525,7 +525,7 @@ export const {
    * Returns an array of property values for the enumerable,
    * string‐valued property keys on the provided object.
    *
    * Returns an array of property values for the enumerable,
    * string‐valued property keys on the provided object.
    *

-   * ※ This is an alias for Object.values.
+   * ※ This is an alias for `Object.values`.

    */
   values: namedValues,
 
    */
   values: namedValues,
 


@@ -533,14 +533,14 @@ export const {
    * Returns a new object with the provided prototype and property
    * descriptors.
    *
    * Returns a new object with the provided prototype and property
    * descriptors.
    *

-   * ※ This is an alias for Object.create.
+   * ※ This is an alias for `Object.create`.

    */
   create: objectCreate,
 
   /**
    * Returns a new object with the provided property keys and values.
    *
    */
   create: objectCreate,
 
   /**
    * Returns a new object with the provided property keys and values.
    *

-   * ※ This is an alias for Object.fromEntries.
+   * ※ This is an alias for `Object.fromEntries`.

    */
   fromEntries: objectFromEntries,
 
    */
   fromEntries: objectFromEntries,
 


@@ -548,7 +548,7 @@ export const {
    * Marks the provided object as non·extensible, and returns the
    * object.
    *
    * Marks the provided object as non·extensible, and returns the
    * object.
    *

-   * ※ This is an alias for Object.preventExtensions.
+   * ※ This is an alias for `Object.preventExtensions`.

    */
   preventExtensions,
 
    */
   preventExtensions,
 


@@ -556,7 +556,7 @@ export const {
    * Marks the provided object as non·extensible and marks all its
    * properties as nonconfigurable, and returns the object.
    *
    * Marks the provided object as non·extensible and marks all its
    * properties as nonconfigurable, and returns the object.
    *

-   * ※ This is an alias for Object.seal.
+   * ※ This is an alias for `Object.seal`.

    */
   seal,
 
    */
   seal,
 


@@ -564,7 +564,7 @@ export const {
    * Sets the values of the enumerable own properties of the provided
    * additional objects on the provided object.
    *
    * Sets the values of the enumerable own properties of the provided
    * additional objects on the provided object.
    *

-   * ※ This is an alias for Object.assign.
+   * ※ This is an alias for `Object.assign`.

    */
   assign: setPropertyValues,
 
    */
   assign: setPropertyValues,
 


@@ -572,7 +572,7 @@ export const {
    * Sets the prototype of the provided object to the provided value
    * and returns the object.
    *
    * Sets the prototype of the provided object to the provided value
    * and returns the object.
    *

-   * ※ This is an alias for Object.setPrototypeOf.
+   * ※ This is an alias for `Object.setPrototypeOf`.

    */
   setPrototypeOf: setPrototype,
 } = Object;
    */
   setPrototypeOf: setPrototype,
 } = Object;


@@ -582,7 +582,7 @@ export const {
    * Removes the provided property key from the provided object and
    * returns the object.
    *
    * Removes the provided property key from the provided object and
    * returns the object.
    *

-   * ※ This function differs from Reflect.deleteProperty and the
+   * ※ This function differs from `Reflect.deleteProperty` and the

    * `delete` operator in that it throws if the deletion is
    * unsuccessful.
    *
    * `delete` operator in that it throws if the deletion is
    * unsuccessful.
    *


@@ -593,7 +593,7 @@ export const {
   /**
    * Returns an array of property keys on the provided object.
    *
   /**
    * Returns an array of property keys on the provided object.
    *

-   * ※ This is effectively an alias for Reflect.ownKeys, except that
+   * ※ This is effectively an alias for `Reflect.ownKeys`, except that

    * it does not require that the argument be an object.
    */
   getOwnPropertyKeys,
    * it does not require that the argument be an object.
    */
   getOwnPropertyKeys,


@@ -602,7 +602,7 @@ export const {
    * Returns the value of the provided property key on the provided
    * object.
    *
    * Returns the value of the provided property key on the provided
    * object.
    *

-   * ※ This is effectively an alias for Reflect.get, except that it
+   * ※ This is effectively an alias for `Reflect.get`, except that it

    * does not require that the argument be an object.
    */
   getPropertyValue,
    * does not require that the argument be an object.
    */
   getPropertyValue,


@@ -611,7 +611,7 @@ export const {
    * Returns whether the provided property key exists on the provided
    * object.
    *
    * Returns whether the provided property key exists on the provided
    * object.
    *

-   * ※ This is effectively an alias for Reflect.has, except that it
+   * ※ This is effectively an alias for `Reflect.has`, except that it

    * does not require that the argument be an object.
    *
    * ※ This includes properties present on the prototype chain.
    * does not require that the argument be an object.
    *
    * ※ This includes properties present on the prototype chain.


@@ -622,8 +622,8 @@ export const {
    * Sets the provided property key to the provided value on the
    * provided object and returns the object.
    *
    * Sets the provided property key to the provided value on the
    * provided object and returns the object.
    *

-   * ※ This function differs from Reflect.set in that it throws if the
-   * setting is unsuccessful.
+   * ※ This function differs from `Reflect.set` in that it throws if
+   * the setting is unsuccessful.

    *
    * ☡ This function throws if the first argument is not an object.
    */
    *
    * ☡ This function throws if the first argument is not an object.
    */


@@ -677,12 +677,12 @@ export const {
    *   property with the same getter *and* setter.
    *
    * The prototype for the resulting object will be taken from the
    *   property with the same getter *and* setter.
    *
    * The prototype for the resulting object will be taken from the

-   * `prototype` property of the provided constructor, or the
-   * `prototype` of the `constructor` of the provided object if the
+   * `.prototype` property of the provided constructor, or the
+   * `.prototype` of the `.constructor` of the provided object if the

    * provided constructor is undefined. If the used constructor has a
    * provided constructor is undefined. If the used constructor has a

-   * nonnullish `Symbol.species`, that will be used instead. If the
+   * nonnullish `.[Symbol.species]`, that will be used instead. If the

    * used constructor or species is nullish or does not have a
    * used constructor or species is nullish or does not have a

-   * `prototype` property, the prototype is set to null.
+   * `.prototype` property, the prototype is set to null.

    *
    * ※ The prototype of the provided object itself is ignored.
    */
    *
    * ※ The prototype of the provided object itself is ignored.
    */


@@ -709,7 +709,7 @@ export const {
         // O is not null or undefined.
         //
         // (If not provided, the constructor will be the value of
         // O is not null or undefined.
         //
         // (If not provided, the constructor will be the value of

-        // getting the `constructor` property of O.)
+        // getting the `.constructor` property of O.)

         const species = constructor?.[SPECIES] ?? constructor;
         return preventExtensions(
           objectCreate(
         const species = constructor?.[SPECIES] ?? constructor;
         return preventExtensions(
           objectCreate(