@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
141 lines (68 loc) • 2.38 kB
Markdown
---
lang: en
title: 'API docs: pooling'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling
permalink: /doc/en/lb4/apidocs.pooling.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/pooling](./pooling.md)
## pooling package
[@loopback/pooling](https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling)
## Classes
<table><thead><tr><th>
Class
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[PoolingService](./pooling.poolingservice.md)
</td><td markdown="1">
A singleton service to maintain a pool of resources. This pool service can be bound to different keys to represent multiple pools. Each binding is a singleton so that the state stays the same for injections into multiple instances for other artifacts.
</td></tr>
</tbody></table>
## Functions
<table><thead><tr><th>
Function
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[createPooledBindingFactory(bindingAddress)](./pooling.createpooledbindingfactory.md)
</td><td markdown="1">
Create a function to return a pooled binding factory
</td></tr>
<tr><td markdown="1">
[getPooledValue(poolingService, requestCtx)](./pooling.getpooledvalue.md)
</td><td markdown="1">
Acquire a resource from the pooling service or pool
</td></tr>
</tbody></table>
## Interfaces
<table><thead><tr><th>
Interface
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[Poolable](./pooling.poolable.md)
</td><td markdown="1">
Life cycle methods that a poolable resource can optionally implement so that they can be triggered by the pooling service
</td></tr>
<tr><td markdown="1">
[PooledValue](./pooling.pooledvalue.md)
</td><td markdown="1">
Pooled resource instance
</td></tr>
<tr><td markdown="1">
[PoolFactory](./pooling.poolfactory.md)
</td><td markdown="1">
Factory for the pooling service
</td></tr>
<tr><td markdown="1">
[PoolingServiceOptions](./pooling.poolingserviceoptions.md)
</td><td markdown="1">
Options to configure a resource pool
</td></tr>
</tbody></table>