ruben-arushanyan / exotic-object Goto Github PK

5.0 1.0 0.0 500 KB

With the help of this library, in JavaScript, we can create exotic objects with custom behavior for each operation that will be applied to the object.

Home Page: https://github.com/Ruben-Arushanyan/exotic-object

License: MIT License

JavaScript 100.00%

javascript proxy exotic-object operator-overloading

exotic-object's People

Contributors

Stargazers

Watchers

exotic-object's Issues

Notes

const syntaxError = () => {
    throw Error('SyntaxError: invalid syntax')
}
const NOOP = function() {}

const createPureProxy = (options={}) => {
    const handler = {
        apply(target, thisArg, argumentsList) {
            syntaxError()
        },
        construct(target, argumentsList, newTarget) {
            syntaxError()
        },
        defineProperty(target, property, descriptor) {
            syntaxError()
        },
        deleteProperty(target, property) {
            syntaxError()
        },
        getOwnPropertyDescriptor(target, prop) {
            syntaxError()
        },
        getPrototypeOf(target) {
            syntaxError()
        },
        has(target, prop) {
            syntaxError()
        },
        isExtensible(target) {
            syntaxError()
        },
        ownKeys(target) {
            syntaxError()
        },
        preventExtensions(target) {
            syntaxError()
        },
        get(target, property, receiver) {
            syntaxError()
        },
        set(target, property, value, receiver) {
            syntaxError()
        },
        setPrototypeOf(target, prototype) {
            syntaxError()
        },
        ...options,
    }

    return new Proxy(NOOP, handler)
}


const str = exoticObject({
    data: {
        count: 1,
    },
    apply: (target, thisArg, argumentsList) => {
        syntaxError()
    },
    get: {
        title: () => {},
        
    },
    set: (target) => {

    }
})

GetNotAllowedError class

OperationNotAllowedError class unit test

delete handler

call defaultHandlers

SetNotAllowedError class

Usage Example readme

SetNotAllowedError class test

resolveOperationHandler()

resolveOperationHandler("call")

resolveOperationHandler("get", "title")

Exotic Object Description

exotic object

object that does not have the default behaviour for one or more of the essential internal methods.

ordinary object

object that has the default behaviour for the essential internal methods that must be supported by all objects

https://forum.kirupa.com/t/js-tip-of-the-day-exotic-objects/643152

Error stack improvements

Description

Improve the error stack for a more user-friendly message.

Additional

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
https://stackoverflow.com/questions/1382107/whats-a-good-way-to-extend-error-in-javascript

unit TEST resolveHandler()

get handler test

Proxy set handler investigation

PrimitiveNotAllowedError test

Full Readme docs

CallNotAllowedError class

class CallNotAllowedError extends OperationNotAllowedError {
    constructor(options) {
        super({
            message: options?.message,
            operation: "Call",
        });
    }
}

CallNotAllowedError unit test

call handler test

isExoticObject test

delete handler test

resolvePropertyOperationHandler()

get handler

DeleteNotAllowedError class

set handler test

toPrimitive test

Proxy get receiver

DeleteNotAllowedError class test

add set handler

call handler

toPrimitive handler

setDefaultHandler method

const {setDefaultHandler} = 'exotic-object'

setDefaultHandler('call', (target, thisArg, argumentsList) => {
        throw new CallNotAllowedError()
})