node-ejs-renderer/node_modules/define-lazy-prop
2024-06-09 13:55:01 -04:00
..
index.d.ts Main initial commit 2024-06-09 13:55:01 -04:00
index.js Main initial commit 2024-06-09 13:55:01 -04:00
license Main initial commit 2024-06-09 13:55:01 -04:00
package.json Main initial commit 2024-06-09 13:55:01 -04:00
readme.md Main initial commit 2024-06-09 13:55:01 -04:00

define-lazy-prop

Define a lazily evaluated property on an object

Useful when the value of a property is expensive to generate, so you want to delay the computation until the property is needed. For example, improving startup performance by deferring nonessential operations.

Install

$ npm install define-lazy-prop

Usage

import defineLazyProperty from 'define-lazy-prop';

const unicorn = {
	// …
};

defineLazyProperty(unicorn, 'rainbow', () => expensiveComputation());

app.on('user-action', () => {
	doSomething(unicorn.rainbow);
});

API

defineLazyProperty(object, propertyName, valueGetter)

object

Type: object

Object to add the property to.

propertyName

Type: string

Name of the property to add.

valueGetter

Type: Function

Called the first time propertyName is accessed. Expected to return a value.