codeql-action/node_modules/define-lazy-prop
github-actions[bot] 40a500c743 Update checked-in dependencies 2023-07-13 09:09:17 +00:00
..
index.d.ts Update checked-in dependencies 2023-07-13 09:09:17 +00:00
index.js Update checked-in dependencies 2023-07-13 09:09:17 +00:00
license Update checked-in dependencies 2023-07-13 09:09:17 +00:00
package.json Update checked-in dependencies 2023-07-13 09:09:17 +00:00
readme.md Update checked-in dependencies 2023-07-13 09:09:17 +00:00

readme.md

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.