Big News: Socket Selected for OpenAI's Cybersecurity Grant Program.Details
Socket
Book a DemoSign in
Socket

reuse-pool

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

reuse-pool

Pool arbitrary objects for reuse

latest
Source
npmnpm
Version
1.0.2
Version published
Maintainers
1
Created
Source

reuse-pool

A simple object pool that uses a factory function to instantiate new objects and an optional prepare callback for preparing objects for reuse.

Installation

Get it:

$ npm install --save reuse-pool

Require it:

var createPool = require('reuse-pool');

API

var pool = createPool(factory, [opts])

Creates a new object pool with the given factory function. opts is an options object, valid keys:

  • prepare: callback used to prepare an object for reuse, called each time an existing object is removed from the pool by a call to pool.get(). It is not called when new objects are created by the factory function.
  • max: maximum number of items to be pooled for reuse; any additional items beyond this number will be discared. Default: Infinity.

pool.get()

If there are objects in the pool, pool.get() returns the most recently recycled object, otherwise it returns a new object created by calling the pool's factory function.

pool.recycle(obj)

Returns obj to the pool for later reuse.

© 2015 Jason Frame [ @jaz303 / jason@onehackoranother.com ]

Released under the ISC license.

Keywords

object

FAQs

Package last updated on 04 Apr 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts