Skip to content

Commit 8c8a196

Browse files
committed
docs: mention tracing in the Status jsdoc
1 parent 9438a9e commit 8c8a196

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

src/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,10 @@ export namespace LRUCache {
229229
*
230230
* The `status` option should be a plain JavaScript object. The following
231231
* fields will be set on it appropriately, depending on the situation.
232+
*
233+
* These objects are also the context objects passed to listeners on the
234+
* `lru-cache:metrics` diagnostic channel, and the `lru-cache` tracing
235+
* channels, in platforms that support them.
232236
*/
233237
export interface Status<K, V> {
234238
/**

0 commit comments

Comments
 (0)