package
Define lazy properties on objects that are initialized once and only when accessed. Also known as a lazy initialization and cached/memoized getters.
npm install lazy-objectGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
![NPM version][npm-badge] [npm-badge]: https://badge.fury.io/js/lazy-object.png
LazyObject.js lets you define properties on an object whose values are initialized only when first accessed. From then on, values are cached/memoized.
Its defineLazyProperty function follows the Object.defineProperty signature
closely and allows you to change whether the defined properties are
configurable, enumerable and writable.
npm install lazy-objectLazyObject.js follows semantic versioning, so feel free to
depend on its major version with something like >= 1.0.0 < 2 (a.k.a ^1.0.0).
var LazyObject = require("lazy-object")
var Net = require("net")
var server = {}
LazyObject.defineLazyProperty(server, "connection", function() {
return Net.connect(23, "example.com")
})Properties are by default defined as configurable, enumerable and
writable. To change that, pass an options object as the last argument.
Then, like Object.defineProperty, all unset properties are set to false.
LazyObject.defineLazyProperty(server, "connection", function() {
return Net.connect(23, "example.com")
}, {configurable: true})The above creates a configurable, but non-enumerable and non-writable
property (both before initialization and after). This prevents anyone from
overwriting the property once initalized.
var LazyObject = require("lazy-object")
var Pg = require("pg")
var Redis = require("redis")
var connections = {}
LazyObject.defineLazyProperties(connections, {
pg: Pg.connect.bind(Pg, "postgres://example.com/database"),
redis: Redis.createClient.bind(Redis)
})You can change the properties' enumerability by passing in an options object as the last argument:
LazyObject.defineLazyProperties(connections, {
pg: Pg.connect.bind(Pg, "postgres://example.com/database"),
redis: Redis.createClient.bind(Redis)
}, {configurable: true, writable: true})The above creates the pg and redis properties as configurable and writable, but not enumerable.
You don't have to define properties directly on the object you want them on. Taking advantage of prototypical inheritance, you can do so only once on the prototype:
var LazyObject = require("lazy-object")
var Net = require("net")
function Telnet(host, port) {
if (host != null) this.host = host
if (port != null) this.port = port
}
Telnet.prototype.host = null
Telnet.prototype.port = 23
LazyObject.defineLazyProperty(Telnet.prototype, "connection", function() {
return Net.connect(this.port, this
Then, only when you first access the connection property on a new Telnet
instance, will the connection be created. Different Telnet instances get their
own connections.
LazyObject.js is released under a Lesser GNU Affero General Public License, which in summary means:
For more convoluted language, see the LICENSE file.
Andri Möll typed this and the code.
Monday Calendar supported the engineering work.
If you find LazyObject.js needs improving, please don't hesitate to type to me now at andri@dot.ee or create an issue online.