securityos/node_modules/define-lazy-prop/readme.md

1.3 KiB

define-lazy-prop Build Status

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

const defineLazyProp = require('define-lazy-prop');

const unicorn = {
	// …
};

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

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

API

defineLazyProp(object, propertyName, fn)

object

Type: Object

Object to add property to.

propertyName

Type: string

Name of the property to add.

fn

Type: Function

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

License

MIT © Sindre Sorhus