X-Git-Url: https://git.ladys.computer/Pisces/blobdiff_plain/40e2e9982438e6011fd02b84fc0e810cf306ea90..83f6aae0d1b8181dc2b0c6ccdba9f2fe2fdba3e6:/object.js?ds=inline diff --git a/object.js b/object.js index 9986291..a403795 100644 --- a/object.js +++ b/object.js @@ -1,14 +1,14 @@ // ♓🌟 Piscēs ∷ object.js // ==================================================================== // -// Copyright © 2022 Lady [@ Lady’s Computer]. +// Copyright © 2022–2023 Lady [@ Lady’s Computer]. // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at . import { bind, call } from "./function.js"; -import { toPrimitive, type } from "./value.js"; +import { ITERATOR, SPECIES, toPrimitive, type } from "./value.js"; /** * An object whose properties are lazy‐loaded from the methods on the @@ -28,12 +28,12 @@ import { toPrimitive, type } from "./value.js"; * 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 { /** - * Constructs a new LazyLoader object. + * Constructs a new `LazyLoader` 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, - * its `enumerable` property, if defined, will always be a + * its `.enumerable` property, if defined, will always be a * boolean). */ constructor(O) { @@ -395,7 +395,7 @@ export const { * 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, @@ -419,7 +419,7 @@ export const { * 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, @@ -428,7 +428,7 @@ export const { * 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, @@ -437,7 +437,7 @@ export const { * 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, @@ -445,7 +445,7 @@ export const { * 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, @@ -455,7 +455,7 @@ export const { * * ☡ This includes both enumerable and non·enumerable properties. * - * ※ This is an alias for Object.getOwnPropertyNames. + * ※ This is an alias for `Object.getOwnPropertyNames`. */ getOwnPropertyNames: getOwnPropertyStrings, @@ -465,14 +465,14 @@ export const { * * ☡ 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. * - * ※ This is an alias for Object.getPrototypeOf. + * ※ This is an alias for `Object.getPrototypeOf`. */ getPrototypeOf: getPrototype, @@ -480,36 +480,36 @@ export const { * 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. * - * ※ This is an alias for Object.isExtensible. + * ※ This is an alias for `Object.isExtensible`. */ - isExtensible, + isExtensible: isExtensibleObject, /** * 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. * - * ※ 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. * - * ※ This is an alias for Object.entries. + * ※ This is an alias for `Object.entries`. */ entries: namedEntries, @@ -517,7 +517,7 @@ export const { * 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, @@ -525,7 +525,7 @@ export const { * 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, @@ -533,14 +533,14 @@ export const { * 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. * - * ※ This is an alias for Object.fromEntries. + * ※ This is an alias for `Object.fromEntries`. */ fromEntries: objectFromEntries, @@ -548,7 +548,7 @@ export const { * 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, @@ -556,7 +556,7 @@ export const { * 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, @@ -564,7 +564,7 @@ export const { * 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, @@ -572,7 +572,7 @@ export const { * 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; @@ -582,7 +582,7 @@ export const { * 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. * @@ -593,7 +593,7 @@ export const { /** * 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, @@ -602,7 +602,7 @@ export const { * 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, @@ -611,7 +611,7 @@ export const { * 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. @@ -622,8 +622,8 @@ export const { * 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. */ @@ -677,26 +677,22 @@ export const { * 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 - * 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 - * `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. */ frozenCopy, } = (() => { - const { - iterator: iteratorSymbol, - species: speciesSymbol, - } = Symbol; const { next: generatorIteratorNext, } = getPrototype(function* () {}.prototype); const propertyDescriptorEntryIterablePrototype = { - [iteratorSymbol]() { + [ITERATOR]() { return { next: bind(generatorIteratorNext, this.generator(), []), }; @@ -713,8 +709,8 @@ export const { // O is not null or undefined. // // (If not provided, the constructor will be the value of - // getting the `constructor` property of O.) - const species = constructor?.[speciesSymbol] ?? constructor; + // getting the `.constructor` property of O.) + const species = constructor?.[SPECIES] ?? constructor; return preventExtensions( objectCreate( species == null || !("prototype" in species)