strictObjectAccess.md

strictObjectAccess(target: object, enabled?: boolean) => proxy

Params

• target: object
• enabled?: boolean
  • Default value is equal to process ? process.env.NODE_ENV === 'development' : true, i.e. enable it in development, but disable it in production.

Returns

A new Proxy instance.

---

What does it do

It takes an object, wraps it with a new Proxy (in order to be able to intercept each property access) and returns the proxy instance. So the returned output behaves same as the input object, but when a object property results in undefined value an error is thrown.

Why is it useful

This is incredibly useful for constants and detecting typos.

Usage

import { strictObjectAccess } from '@ackee/redux-utils';

const Types = {
    A: 'a',
    B: 'b',
};

// Access defined property:
console.log(Types.A); // -> 'a'
// Access undefined property:
console.log(Types.X); // -> 'undefined'

const TypesProxy = strictObjectAccess(Types);

// Access defined property:
console.log(TypesProxy.A); // -> 'a'
// Access undefined property:
console.log(TypesProxy.X); // This is going to throw an error:
/*
    Uncaught StrictAccessError: Accessing this object property results in an undefined value.
    Used property key: 'X',
    Affected object: {
        "A": 'a',
        "B": 'b'
    }
*/