Configurable Memoized Read-Only

Define a configurable memoized read-only object property.

Installation

npm install @stdlib/utils-define-memoized-configurable-read-only-property

Alternatively,

To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
If you are using Deno, visit the deno branch (see README for usage intructions).
For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var setMemoizedConfigurableReadOnly = require( '@stdlib/utils-define-memoized-configurable-read-only-property' );

setMemoizedConfigurableReadOnly( obj, prop, fcn )

Defines a configurable memoized read-only object property.

var obj = {};

function foo() {
    return 'bar';
}

setMemoizedConfigurableReadOnly( obj, 'foo', foo );

var v = obj.foo;
// returns 'bar'

The last argument should be a synchronous function whose return value will be memoized and set as the property value.

Notes

A configurable read-only property is enumerable.

Examples

var fibonacci = require( '@stdlib/math-base-special-fibonacci' );
var setMemoizedConfigurableReadOnly = require( '@stdlib/utils-define-memoized-configurable-read-only-property' );

function Foo() {
    var self;
    if ( !(this instanceof Foo) ) {
        return new Foo();
    }
    self = this;
    this.count = 0;
    setMemoizedConfigurableReadOnly( this, 'fibo', fibo );
    return this;

    function fibo() {
        self.count += 1;
        return fibonacci( 73 );
    }
}

var foo = new Foo();

var i;
for ( i = 0; i < 10; i++ ) {
    console.log( 'F: %d. Count: %d.', foo.fibo, foo.count );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.