@stdlib/utils-define-memoized-property
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    Define Memoized Property

    NPM version Build Status Coverage Status dependencies

    Define a memoized object property.

    Installation

    npm install @stdlib/utils-define-memoized-property

    Usage

    var defineMemoizedProperty = require( '@stdlib/utils-define-memoized-property' );

    defineMemoizedProperty( obj, prop, descriptor )

    Defines a memoized object property.

    var obj = {};
    
    function foo() {
        return 'bar';
    }
    
    defineMemoizedProperty( obj, 'foo', {
        'configurable': false,
        'enumerable': true,
        'writable': false,
        'value': foo
    });
    
    var v = obj.foo;
    // returns 'bar'

    A property descriptor has the following required properties:

    • value: synchronous function whose return value will be memoized and set as the property value.

    A property descriptor has the following optional properties:

    • configurable: boolean indicating if property descriptor can be changed and if the property can be deleted from the provided object. Default: false.
    • enumerable: boolean indicating if the property shows up when enumerating object properties. Default: false.
    • writable: boolean indicating if the value associated with the property can be changed with an assignment operator. Default: false.

    Notes

    • Until deferred evaluation, an object property is configurable.

    Examples

    var fibonacci = require( '@stdlib/math-base-special-fibonacci' );
    var defineMemoizedProperty = require( '@stdlib/utils-define-memoized-property' );
    
    function Foo() {
        var self;
        if ( !(this instanceof Foo) ) {
            return new Foo();
        }
        self = this;
        this.count = 0;
        defineMemoizedProperty( this, 'fibo', {
            'value': 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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/utils-define-memoized-property

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    8

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    42.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser